Расширенный запрос состояния заказа (getOrderStatusExtended.do)

В настоящем документе при описании параметров запросов и ответов используются следующие обозначения типов данных:

A<n> – последовательность латинских букв длины <n>;
A..<n> – последовательность латинских букв длиной, не превышающей <n>;
N<n> – последовательность цифр длины <n>;
N..<n> – последовательность цифр длиной, не превышающей <n>;
AN<n> – последовательность латинских букв и цифр фиксированной длины <n>;
AN..<n> – последовательность латинских букв и цифр длиной, не превышающей <n>;
ANS<n> – последовательность латинских букв, цифр и символов фиксированной длины <n>
ANS..<n> – последовательность латинских букв, цифр и символов длиной, не превышающей <n>;
UTC – дата и время, при этом: дата должна быть передана без указания часового пояса, время московское, для протокола SOAP используется стандартная кодировка xs:dateTime.

Пользуясь протоколом REST, тело сообщения запроса следует отправлять с типом: 'Content-Type: application/x-www-form-urlencoded'.

Параметры запроса

Параметры запроса представлены в таблице ниже.

Название	Тип	Обязательно	Описание
`userName`	AN..30	нет (нужно указать либо пару логин и пароль, либо токен)	Логин служебной учётной записи продавца. При передаче логина и пароля для аутентификации в платёжном шлюзе параметр `token` передавать не нужно.
`password`	AN..200	нет (нужно указать либо пару логин и пароль, либо токен)	Пароль служебной учётной записи продавца. При передаче логина и пароля для аутентификации в платёжном шлюзе параметр `token` передавать не нужно.
`token`	AN..256	нет (нужно указать либо пару логин и пароль, либо токен)	Открытый ключ, который можно использовать для аутентификации при выполнении запроса. Если для аутентификации используются логин и пароль, параметр `token` передавать не нужно. Чтобы получить открытый ключ, обратитесь в техническую поддержку.
`orderId`	ANS36	Да (см. примечание ниже)	Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа не удалась по причине ошибки, детализированной в ErrorCode.
`orderNumber`	ANS..32	Да (см. примечание ниже)	Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы. Если номер заказа генерируется на стороне платёжного шлюза, этот параметр передавать необязательно
`language`	A2	Нет	Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию.
`merchantLogin`	ANS..255	нет	Чтобы получить статус заказа конкретного продавца, а не текущего пользователя, укажите логин продавца.

В запросе должен присутствовать либо orderId, либо orderNumber. Если в запросе присутствуют оба параметра, то приоритетным считается orderId.

Параметры ответа

Существует три набора параметров ответа. Какие именно наборы параметров будут возвращены, завит от версии getOrderStatusExtended, указанной в настройках продавца. Эти параметры будут возвращены в ответе независимо от версии getOrderStatusExtended.

Описание версий

Версия
1	`orderBundle` (для заказов с корзиной)
2	`authDateTime` `terminalId` `authRefNum`
3	`paymentAmountInfo` → `approvedAmount`, `depositedAmount`, `paymentState`, `refundedAmount` `bankInfo` → `bankCountryCode`, `bankCountryName`, `bankName`
4	`loyaltyInfo` → `awardBonus`, `paymentBonus`,
5	`refunds`
6	`chargeback`
7	`cardAuthInfo` → `secureAuthInfo` → `paResStatus`, `veResStatus`, `paResCheckStatus`
8	`cardAuthInfo` → `paymentSystem`, `product`
9	`paymentWay`
10	`depositedDate`
11	Нет изменений
12	`refundedDate` `reversedDate`
13	`payerData` → `email`, `phone`, `postAddress`
14	`transactionAttributes`
15	`prepaymentMdOrder` `partpaymentMdOrders`
16	`feUtrnno`
17	`cardAuthInfo` → `productCategory`
18	`totalAmount`
19	`avsCode`
20	`bindingInfo` → `externalCreated`
21	`refunds` → `externalRefundId`
22	Нет изменений
23	Нет изменений
24	`ofdOrderBundle`
25	Нет изменений
26	`refunds` → `approvalCode`
27	`authRefNum`
28	Нет изменений
29	Нет изменений
30	`cardAuthInfo` → `secureAuthInfo` → `aResTransStatus`, `rReqTransStatus`, `threeDsProtocolVersion`
31	Нет изменений
32	`orderBundle` → `loyalties` (для заказов с корзиной)
33	`displayErrorMessage`
34	`orderBundle` → `cartItems` → `items` →`depostedItemAmount`, `itemPrice`
35	`cardAuthInfo` → `corporateCard`
36	Нет изменений
37	`tii` `usedPsdIndicatorValue`

Название	Тип	Обязательно	Описание	Версия getOrderStatusExtended
`orderNumber`	ANS..32	Да	Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы. Если номер заказа генерируется на стороне платёжного шлюза, этот параметр передавать необязательно	Все версии.
`orderStatus`	N1	Нет	По значению этого параметра определяется состояние заказа в платёжной системе. Отсутствует, если заказ не был найден. Возможны следующие значения: 0 - заказ зарегистрирован, но не оплачен; 1 - предавторизованная сумма захолдирована (для двухстадийных платежей); 2 - проведена полная авторизация суммы заказа; 3 - авторизация отменена; 4 - по транзакции была проведена операция возврата; 5 - инициирована авторизация через ACS банка-эмитента; 6 - авторизация отклонена.	Все версии.
`actionCode`	ANS..6	Да	Код ответа процессинга. Полный перечень кодов ответов процессинга и расшифровки этих кодов размещены на отдельной странице.	Все версии.
`actionCodeDescription`	AN..512	Да	Расшифровка кода ответа на языке, переданном в параметре запроса language.	Все версии.
`errorCode`	N..2	Нет	Код ошибки. Может отсутствовать, если результат не привёл к ошибке. См. описание кодов ошибок ниже.	Все версии.
`errorMessage`	AN..512	Нет	Описание ошибки на языке, переданном в параметре `language` в запросе.	Все версии.
`amount`	N..12	Да	Сумма платежа в минимальных единицах валюты.	Все версии.
`currency`	N3	Нет	Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию.	Все версии.
`date`	ANS	Да	Дата регистрации заказа в формате UNIX-времени (POSIX-времени).	Все версии.
`depositedDate`	N	Нет	Дата оплаты заказа в формате UNIX-времени (POSIX-времени).	10 и выше
`orderDescription`	ANS..600	Нет	Описание заказа, переданное при его регистрации.	Все версии.
`ip`	ANS..39	Да	IP-адрес покупателя. IPv6 поддерживается во всех запросах (до 39 символов).	Все версии.
`authRefNum`	AN..24	Нет	Учётный номер авторизации платежа, который присваивается при регистрации платежа.	27 и выше
`refundedDate`	N	Нет	Дата и время возврата, показанные как количество миллисекунд, прошедших с 00:00 GMT 1 января 1970 года (время Unix). Пример: 1740392720718 (соответствует времени 24 февраля 2025 года, 10:25:20 (UTC)).	12 и выше, обязательно с 27
`reversedDate`	N	Нет	Дата и время отмены платежа, показанные как количество миллисекунд, прошедших с 00:00 GMT 1 января 1970 года (время Unix). Пример: 1740392720718 (соответствует времени 24 февраля 2025 года, 10:25:20 (UTC)).	12 и выше
`paymentWay`	AS..14	да	Способ совершения платежа (платёж в с вводом карточных данных, оплата по связке и т. п.). Может принимать следующие значения: `CARD` - оплата с вводом карточных данных; `CARD_BINDING` - оплата связкой; `CARD_MOTO` - оплата через колл-центр; `CARD_PRESENT` - оплата как cardPresent; `SBRF_SBOL` - оплата через Сбербанк Онлайн; `SBRF_SBOL_BINDING` - оплата через связку Сбербанк Онлайн; `UPOP` - оплата через China Union Pay; `FILE_BINDING` - оплата через файл; `FILE_SBP_C2B_BINDING` - СБП оплата через файл; `SMS_BINDING` - оплата через смс; `P2P` - перевод с карты на карту; `P2P_BINDING` - перевод связкой; `PAYPAL` - оплата со счёта PayPal; `MTS` - оплата со счёта МТС; `APPLE_PAY` - Apple Pay; `APPLE_PAY_BINDING` - оплата связкой Apple Pay; `APPLE_PAY_RAW` - оплата Apple Pay с данными по связке на стороне мерчанта (инициирующие и последующие платежи); `ANDROID_PAY` - Android Pay; `ANDROID_PAY_BINDING` - оплата связкой Android Pay; `GOOGLE_PAY_CARD` - Google Pay нетокенизированная; `GOOGLE_PAY_RAW` - оплата Google Pay с данными по связке на стороне мерчанта (инициирующие и последующие платежи); `GOOGLE_PAY_CARD_BINDING` - оплата связкой с не токенизированной картой GooglePay; `GOOGLE_PAY_TOKENIZED` - Google Pay токенизированная; `GOOGLE_PAY_TOKENIZED_BINDING` - оплата связкой с токенизированной картой GooglePay; `SAMSUNG_PAY` - Samsung Pay; `SAMSUNG_PAY_BINDING` - оплата связкой Samsung Pay; `SAMSUNG_PAY_RAW` - оплата Samsung Pay с данными по связке на стороне мерчанта (инициирующие и последующие платежи); `IPOS` - оплата iPOS; `SBERID` - оплата SberID; `SENDY` - оплата Sendy; `SBP_C2B` - Оплата СБП (Сервис Быстрых платежей) для C2B; `SBP_C2B_BINDING` - оплата связкой СБП (Сервис Быстрых Платежей) для C2B; `SBP_B2C` - выплаты СБП; `TOKEN_PAY` - оплата токеном напрямую; `TOKEN_PAY_BINDING` - оплата токенизированной связкой; `YANDEX_PAY_CARD` - YandexPay нетокенизированная; `YANDEX_PAY_TOKENIZED` - YandexPay токенизированная; `YANDEX_PAY_CARD_BINDING` - оплата связкой с не токенизированной картой YandexPay; `YANDEX_PAY_TOKENIZED_BINDING` - оплата связкой с токенизированной картой YandexPay; `MONEY_STREAM` - оплата с баланса мобильного телефона через сервис MoneyStream; `BNPL` - оплата заказа через механизм BNPL (Buy Now Pay Later); `MTS_INSTALLMENT` - оплата в рассрочку через МТС Банк; `MTS_PAY` - MTS Pay; `QR` - оплата по QR-коду; `ALFAPAY_PLATIQR` - оплата Alfa Pay по QR-коду; `TINKOFFPAY_PLATIQR` - оплата Tinkoff Pay по QR-коду.	09 и выше.
`avsCode`	A1	Нет	AVS Response Сode - код ответа AVS-проверки (проверка адреса и почтового индекса держателя карты). Возможные значения: A – почтовый индекс и адрес совпадают; B – адрес совпадает, почтовый индекс не совпадает; C – почтовый индекс совпадает, адрес не совпадает; D – почтовый индекс и адрес не совпадают; E – проверка данных запрошена, но результат неуспешен; F – некорректный формат запроса AVS/AVV проверки.	19 и выше.
`spasiboAllowed`	boolean	Нет	Признак наличия спасибо на связке	Все версии.
`feeAmount`	N..12	Нет	Сумма комиссии в минимальных единицах валюты.	11 и выше.
`prepaymentMdOrder`	Строка	Нет	Уникальный идентификатор заказа на предоплату в Платёжном Шлюзе. Используется для привязки заказа с предоплатой с чеком на постоплату.	15 и выше.
`partpaymentMdOrders`	Массив ANS	Нет	Массив последующих заказов на частичную оплату.	15 и выше.
`feUtrnno`	N..18	Нет	Номер транзакции FE.	16 и выше.
`displayErrorMessage`	ANS	Нет	Отображаемое сообщение об ошибке.	33 и выше.
`tii`	A2	Нет	Параметр, указывающий на то, какой тип операции будет проводиться со стороны инициатора (мерчанта или клиента). См. описание ниже.	37 и выше.
`usedPsdIndicatorValue`	ANS	Нет	Тип исключения SCA (Strong Customer Authentication). Содержит значение, переданное при оплате заказа в параметре `externalScaExemptionIndicator`. Допустимые значения: LVP – транзакция типа Low Value Payments. Транзакция может быть отнесена к транзакциям с низким уровнем риска на основе суммы транзакции, количества транзакций клиента в день или общей дневной суммы платежей клиента. TRA – транзакция типа Transaction Risk Analysis, т.е. транзакция, прошедшая успешную антифрод-проверку.	37 и выше.
Элемент `merchantOrderParams` – присутствует в ответе, если в заказе содержатся дополнительные параметры продавца. Может содержать, например, `originalResponseCode` - оригинальный код ответа, полученный от НСПК (если был передан НСПК в ответ на запросы оплаты, регистрации или завершения заказа). Каждый дополнительный параметр заказа представлен в отдельном элементе `merchantOrderParams`.
`name`	AN..20	Нет	Название дополнительного параметра.	Все версии.
`value`	ANS..2000	Нет	Значение дополнительного параметра - до 2000 символов.	Все версии.
При оплате с возможностью интернет-кредитования в элементе `merchantOrderParams` передается параметр `registerOrderId` - идентификатор заказа в прокси интернет-кредитования, а также следующие параметры.
Название	Тип	Обязательно	Описание
`rightTerms`	ANS…255	Нет	Желаемый срок кредитования в месяцах. Возвращается в ответе, если при регистрации заказа был передан параметр `rightTerms`.
`term`	N..2	Да	Реальный срок кредитования в месяцах.
Элемент `cardAuthInfo` – в элементе лежит структура, состоящая из списка элемента `secureAuthInfo` и следующих параметров.
`maskedPan`	N..19	Нет	Маскированный номер карты, которая использовалась для оплаты.	Все версии.
`expiration`	ANS	Нет	Срок истечения действия карты в формате ГГГГММ.	Все версии.
`cardholderName`	AS..26	Нет	Имя держателя карты латиницей, если доступно. Длина поля ограничена 26 символами (латинские буквы, точка, пробел).	Все версии.
`approvalCode`	AN6	Нет	Код авторизации международной платёжной системы. Поле фиксированной длины (6 символов), может содержать цифры и латинские буквы.	Все версии.
`chargeback`	A..5	Нет	Были ли средства принудительно возвращены покупателю банком. Возможны следующие значения: `true` (истина) - средства были возвращены; `false` (ложь) - средства не были возвращены.	06 и выше.
`paymentSystem`	N..10	да	Наименование платёжной системы. Доступны следующие варианты: `VISA`; `MASTERCARD`; `AMEX`; `JCB`; `CUP`; `MIR`. Если заказ был оплачен Платежным счетом или сервисом «Плати частями», то данный параметр не возвращается.	08 и выше.
`product`	AN..255	да	Дополнительные сведения о корпоративных картах. Эти сведения заполняются службой технической поддержки. Если такие сведения отсутствуют, возвращается пустое значение.	08 и выше.
`productCategory`	строка	да	Дополнительные сведения о категории корпоративных карт. Эти сведения заполняются службой технической поддержки в консоли управления. Если такие сведения отсутствуют, возвращается пустое значение. Возможные значения: DEBIT, CREDIT, PREPAID, NON_MASTERCARD, CHARGE, DIFFERED_DEBIT.	17 и выше.
`corporateCard`	A..5	да	Признак того, является ли карта корпоративной. Возможные значения: false - не является корпоративной картой, true - является корпоративной картой. Также может по поиску возвращаться пустое значение, это означает, что значение не найдено.	35 и выше.
Элемент `secureAuthInfo` (элемент состоит из элемента `eci` и элемента `threeDSInfo`, являющимся списком параметров `cavv` и `xid`).
`eci`	N..4	Нет	Электронный коммерческий индикатор.	Все версии.
`cavv`	ANS..200	Нет	Значение проверки аутентификации владельца карты. Указано только после оплаты заказа и в случае соответствующего разрешения.	Все версии.
`xid`	ANS..80	Нет	Электронный коммерческий идентификатор транзакции. Указан только после оплаты заказа и в случае соответствующего разрешения.	Все версии.
`aresTransStatus`	A1	Нет	Статус транзакции из ответа от ACS на запрос аутентификации (ARes). Передается при использовании 3DS 2.	30 и выше.
`rreqTransStatus`	A1	Нет	Статус транзакции из запроса для передачи результатов аутентификации пользователя от ACS (RReq). Передается при использовании 3DS 2.	30 и выше.
`threeDSProtocolVersion`	N..12	Нет	Версия протокола 3DS. Возможные значения: «1.0.2» для 3DS1; «2.1.0» для 3DS2.; «2.2.0» для 3DS2.	30 и выше.
`paResStatus`	ANS	Нет	Параметр указывает, квалифицируется ли транзакция как аутентифицированная транзакция.	07 и выше.
`veResStatus`	ANS	Нет	Параметр указывает, может ли быть аутентифицирован идентификатор учетной записи.	07 и выше.
`paResCheckStatus`	ANS	Нет	Результат проверки PaRes.	07 и выше.
Элемент `bindingInfo` состоит из следующих параметров.
`clientId`	ANS..255	Нет	Номер (идентификатор) клиента в системе магазина. Используется для реализации функционала связок. Может присутствовать, если магазину разрешено создание связок. Указание этого параметра при платежах по связке необходимо - в противном случае платёж будет неуспешен.	Все версии.
`bindingId`	AN..255	Нет	Идентификатор созданной ранее связки. Может использоваться, только если у продавца есть разрешение на работу со связками. Если этот параметр передаётся в данном запросе, то это означает: 1. Данный заказ может быть оплачен только с помощью связки; 2. Плательщик будет перенаправлен на платёжную страницу, где требуется только ввод CVC.	Все версии.
`authDateTime`	ANS	Нет	Дата и время авторизации в формате UNIX-времени (POSIX-времени).	02 и выше.
`authRefNum`	AN..24	Нет	Учётный номер авторизации платежа, который присваивается при регистрации платежа.	02 и выше.
`terminalId`	AN..10	Нет	Идентификатор терминала в процессинге, через который осуществлялась оплата.	02 и выше.
`externalCreated`	boolean	Нет	Признак, показывающий, создана ли связка во внешнем сервисе.	20 и выше.
Элемент `paymentAmountInfo` состоит из следующих параметров.
`approvedAmount`	N..12	Нет	Сумма, подтверждённая к списанию.	03 и выше.
`depositedAmount`	N..12	Нет	Сумма в минимальных единицах валюты (например, в копейках), подтверждённая для списания с карты.	03 и выше.
`refundedAmount`	N..12	Нет	Сумма возврата в минимальных единицах валюты.	03 и выше.
`paymentState`	A..10	Нет	Состояние заказа, параметр может принимать следующие значения: `CREATED` - заказ создан; `APPROVED` - заказ подтверждён; `DEPOSITED` - заказ завершён; `DECLINED` - заказ отклонён; `REVERSED` - заказ отменён; `REFUNDED` - произведён возврат средств по заказу.	03 и выше.
`totalAmount`	N..12	Нет	Сумма заказа + fee (комиссия, если она была использована в заказе).	18 и выше.
Элемент `bankInfo` состоит из параметров.
`bankName`	ANS..50	Нет	Наименование банка-эмитента.	03 и выше.
`bankCountryCode`	AN..7	Нет	Код страны банка-эмитента.	03 и выше.
`bankCountryName`	AN..160	Нет	Наименование страны банка-эмитента на языке, переданном в параметре language в запросе, или на языке пользователя, вызвавшего метод, если язык в запросе не указан.	03 и выше.
Элемент `loyaltyInfo/loyaltyInfos` (состоит из элемента `loyaltyName` и тэгов `paymentBonus` и `awardBonus`) - Тэг, содержащий данные о состоянии бонусных баллов по программам лояльности в заказе
Элемент `loyaltyInfo` (состоит из элемента `loyaltyName` и тэгов `paymentBonus` и `awardBonus`)		Нет	Тэг, содержащий данные о состоянии бонусных баллов по программам лояльности в заказе	04 и выше.
Элемент `loyaltyInfos` (состоит из элемента `loyaltyName` и тэгов `paymentBonus` и `awardBonus`)		Нет	Тэг, содержащий данные о состоянии бонусных баллов по программам лояльности в заказе	15 версия и выше.
`loyaltyName`	ANS..512	Нет	Наименование программы лояльности(для Сбербанк спасибо это «sbrf_spasibo» и «sbrf_sbermiles»).	15 версия и выше.
paymentBonus		Нет	Тэг с атрибутами, содержащими данные о состоянии использованных баллов для списания при оплате заказа. См. содержимое блока paymentBonus ниже.	04 и выше.
awardBonus		Нет	Тэг с атрибутами, содержащими данные о состоянии средств, использованных для начисления баллов при оплате заказа. См. содержимое блока awardBonus ниже.	04 и выше.
`orderBundle`	Не актуально	Да	Блок, содержащий корзину товаров заказа. Описание его атрибутов представлено ниже. (Перейти к описанию.)	01 и выше.
ofdOrderBundle	См. описание	Нет	Пересчитанная для ОФД остаточная корзина (с учетом возвратов). См содержимое блока ofdOrderBundle.	24 В настоящее время реализовано исключительно для АТОЛ систем версии v5 (1.2). Настоящая корзина отображается только при передаче бонусных баллов «Спасибо» при регистрации заказа.
Элемент `refunds` содержит информацию по возвратам. Добавляется в ответ на запрос `getOrderStatusExtended` 05 версии и выше и присутствует только, если есть возврат по заказу.
`referenceNumber`	N12	Нет	Ссылочный номер транзакции, присваиваемый платёжным шлюзом после её завершения.	05 и выше.
`actionCode`	ANS..6	Нет	Код ответа процессинга. Полный перечень кодов ответов процессинга и расшифровки этих кодов размещены на отдельной странице.	05 и выше.
`amount`	N..12	Нет	Сумма платежа в минимальных единицах валюты.	05 и выше.
`date`	ANS	Нет	Дата возврата заказа в формате YYYYMMDDHHMMSS (например, 20210729231846).	05 и выше.
`approvalCode`	AN6	Нет	Код авторизации международной платёжной системы. Поле фиксированной длины (6 символов), может содержать цифры и латинские буквы.	26 и выше
`externalRefundId`	AN..30	Нет	Идентификатор возврата. При попытке повторного возврата, проверяется `externalRefundId`: если есть, то возвращается успешный ответ с данными о возврате, если нет - осуществляется возврат.	21 и выше.
Элемент `payerData` состоит из параметров.
`email`	ANS..40	Нет	Адрес электронной почты покупателя.	13 и выше.
`phone`	NS..12	Нет	Номер телефона покупателя. Всегда нужно указывать код страны, при этом можно указывать или не указывать знак + . Таким образом, допустимы следующие варианты: +79998887766; 79998887766.	13 и выше.
`postAddress`	ANS..255	Нет	Адрес доставки.	13 и выше.

Содержимое блока paymentBonus

Название	Тип	Обязательно	Описание
`approvedAmountBonus`	N..20	Нет	Сумма баллов к списанию при оплате заказа.
`depositedAmountBonus`	N..20	Нет	Подтвержденная сумма в баллах для списания на момент запроса.
`refundedAmountBonus`	N..20	Нет	Сумма возврата в баллах на момент запроса.
`pcId`	ANS..512	Нет	Идентификатор последней проведённой операции с суммой для начисления баллов в процессинге лояльности.
`successful`	ANS..512	Да	Признак успешности операции, возможны следующие значения: `true` (успешно); `false` (неуспешно).
`paymentOperation`	ANS..512	Да	Тип последней проведенной операции со списываемыми баллами (PAYMENT, REVERSE, REFUND_PAYMENT)

Содержимое блока awardBonus

Название	Тип	Обязательно	Описание
`approvedAmountAward`	N..20	Нет	Первоначальная сумма, на которую было произведено начисление бонусных баллов.
`depositedAmountAward`	N..20	Нет	Подтверждённая сумма заказа, на которую произведено начисление бонусных баллов.
`refundedAmountAward`	N..20	Нет	Сумма возврата заказа, на которую произведено начисление бонусных баллов.
`pcId`	AN..512	Нет	Идентификатор последней проведённой операции с суммой для начисления баллов в процессинге лояльности.
`successful`	AN..512	Да	Признак успешности операции, возможны следующие значения: `true` (успешно); `false` (неуспешно).
`paymentOperation`	ANS..512	Да	Тип последней проведенной операции с суммой для начисления баллов (AWARD, REVERSE, REFUND_AWARD).

tii

Параметры блока tii

Значение	Описание	Тип транзакции	Инициатор транзакции	Данные карты	Данные сохраняются
CI	Первоначальный общий CIT (customer initiated transaction)	Инициирование	Клиент	Вводятся клиентом	Да
II	Первоначальный взнос CIT (customer initiated transaction)	Инициирование	Клиент	Вводятся клиентом	Да
RI	Первичный Рекуррентный CIT (customer initiated transaction)	Инициирование	Клиент	Вводятся клиентом	Да
F	Внеплановый CIT (customer initiated transaction)	Последующий	Клиент	Клиент выбирает карту вместо ручного ввода	Нет
U	Внеплановый MIT (merchant initiated transaction)	Последующий	Мерчант	Нет ручного ввода, мерчант передает данные	Нет
R	Рекуррентный MIT (merchant initiated transaction)	Последующий	Мерчант	Нет ручного ввода, мерчант передает данные	Нет
I	Рассрочка MIT (merchant initiated transaction)	Последующий	Мерчант	Нет ручного ввода, мерчант передает данные	Нет

orderBundle

orderBundle состоит из следующих элементов.

Название	Тип	Обязательно	Описание	Версия getOrderStatusExtended
`orderCreationDate`	ANS..21	Нет	Дата создания заказа в формате `YYYY-MM-DDTHH:mm:ss`.	01 и выше.
`customerDetails`	Не актуально	Нет	Блок с атрибутами данных о покупателе. Описание его атрибутов представлено ниже. (Перейти к описанию.)	01 и выше.
`cartItems`	Не актуально	Да	Блок с атрибутами товарных позиции корзины товаров. Описание его атрибутов представлено ниже. (Перейти к описанию.)	01 и выше.

customerDetails

customerDetails состоит из следующих элементов.

Название	Тип	Обязательно	Описание	Версия getOrderStatusExtended
`email`	ANS..40	См. примечание ниже.	Адрес электронной почты покупателя.	01 и выше.
`phone`	NS..12	См. примечание ниже.	Номер телефона клиента. Примеры: +79000000000 89000000000 9000000000 79000000000 В случае передачи номера в отдельном параметре и в дополнительных параметрах, в качестве основного использоваться будет номер, указанный в настоящем параметре `phone`. При использовании АТОЛ фискализации параметр `phone` следует передавать в следующем формате: Номер телефона необходимо передать вместе с кодом страны без пробелов и дополнительных символов кроме символа «» (номер «371 2 1234567» необходимо передать как »+37121234567«). Если номер телефона относится к России (префикс »+7«), то значение можно передавать без префикса (номер »+79251234567« можно передать как «9251234567»). Максимальная длина строки - 64 символа. В запросе должно быть обязательно заполнено одно из полей: `email` или `phone`.	01 и выше.
`fullName`	ANS..100	Нет	Фамилия, имя и отчество плательщика. Параметр возвращается только в том, случае если был передан партнером при регистрации.	01 и выше
`passport`	ANS..100	Нет	Серия и номер паспорта плательщика в следующем формате: `2222888888`. Параметр возвращается только в том, случае если был передан партнером при регистрации.	01 и выше
`inn`	N..12	Нет	Идентификационный номер налогоплательщика. Допускается передавать 10 или 12 символов. Параметр возвращается только в том, случае если был передан партнером при регистрации.	01 и выше

cartItems

cartItems состоит из следующих элементов.

Название	Тип	Обязательно	Описание	Версия getOrderStatusExtended
`items`	Не актуально	Да	Массив блоков, описывающих товарные позиции в корзине. Информация по каждой товарной позиции Корзины передаётся в отдельном блоке, входящем в состав items. Не используйте внутри этого блока сочетание символов «‘)», в противном случае это приведёт к ошибке на стороне шлюза. (Перейти к описанию.)	03 и выше.

items

items состоит из следующих элементов.

Название	Тип	Обязательно	Описание	Версия getOrderStatusExtended
`positionId`	ANS..12	Да	Уникальный идентификатор товарной позиции внутри корзины заказа.	01 и выше.
`name`	ANS..100	Да	Наименование или описание товарной позиции в свободной форме. Используйте `\\` - для передачи \ используйте \`« - для передачи` » где « означает знак кавычек	01 и выше.
`quantity`	N..18	Да	Элемент, описывающий общее количество товарных позиций одного `positionId` и их меру измерения. Описание его атрибутов представлено ниже. (Перейти к описанию.)	03 и выше.
`itemAmount`	N..12	Нет	Сумма стоимости всех товарных позиций одного `positionId` в минимальных единицах валюты. `itemAmount` обязателен к передаче, только если не был передан параметр `itemPrice`. В противном случае передача `itemAmount` не требуется. Если же в запросе передаются оба параметра: `itemPrice` и `itemAmount`, то `itemAmount` должен равняться `itemPrice * quantity`, в противном случае запрос завершится с ошибкой. При расчёте параметра `itemAmount = itemPrice*quantity` результат округляется до второго знака после десятичного разделителя. Например, если результат вычислений равен `100,255`, то итоговый результат будет равен `100,26`.	01 и выше.
`depositedItemAmount`	Строка	Нет	Сумма в минимальных единицах валюты одного `positionId`, подтверждённая для списания с карты.	34 и выше.
`itemPrice`	N..18	Да	Стоимость одной товарной позиции в минимальных единицах валюты. Обязательно для продавцов с фискализацией. itemPrice не может быть меньше 0. itemPrice может передаваться как строкой, так и целочисленным типом.	34 и выше.
`itemCurrency`	N3	Нет	Код валюты товарной позиции ISO 4217. Если не указан, считается равным валюте заказа.	01 и выше.
`itemCode`	ANS..100	Да	Номер (идентификатор) товарной позиции в системе магазина. Во всех методах передача артикула `itemcode`/`code` обязательна.	01 и выше.

quantity

quantity состоит из следующих элементов.

Название	Тип	Обязательно	Описание	Версия getOrderStatusExtended
`value`	N..18	Да	Количество товарных позиций данного `positionId`. Для указания дробных чисел используйте десятичную точку.	01 и выше.
`measure`	ANS..20	Да	Мера измерения количества товарной позиции.	01 и выше.

Содержимое блока ofdOrderBundle

Название	Тип	Обязательно	Описание
`name`	ANS..100	Да	Наименование или описание товарной позиции в свободной форме.
`itemAmount`	N..18	Да	Сумма стоимости всех товарных позиций одного `positionId` в деньгах в минимальных единицах валюты.
`itemPrice`	N..18	Да	Стоимость одной товарной позиции в минимальных единицах валюты. Обязательно для продавцов с фискализацией. itemPrice не может быть меньше 0. itemPrice может передаваться как строкой, так и целочисленным типом.
quantity			Элемент, описывающий общее количество товарных позиций одного `positionId` и их меру измерения. Описание его атрибутов представлено ниже.
quantity.value	N..18	Да	Количество товарных позиций данного positionId. Для указания дробных чисел используйте десятичную точку
quantity.measure	ANS..20	Да	Мера измерения количества товарной позиции.
transactionAttributes			Элемент `transactionAttributes`, содержит сведения о деталях заказа. Передается с gOSE 14 версии и выше.
`transactionAttributes.name`	ANS..255	Нет	Название дополнительного параметра.
`transactionAttributes.value`	ANS..2000	Нет	Значение дополнительного параметра.
transactionAttributes[`hashDpan`]	ANS..2000	Нет	Хешированный DPAN (информация о карте Клиента), передающийся в рамках работы со SberPay (передается при наличии у Мерчанта соответствующей пермиссии).
`itemAttributes`			Тэг, предназначенный для передачи набора атрибутов товарной позиции. Атрибуты следует указывать следующим образом. `"itemAttributes":[{"name":"paymentMethod","value":"1"},{"name":"paymentObject","value":"1"}]`
itemAttributes[`paymentMethod`]	N..2	Да	Тип оплаты возможны следующие значения: `1` - полная предварительная оплата до момента передачи предмета расчёта; `2` - частичная предварительная оплата до момента передачи предмета расчёта; `3` - аванс; `4` - полная оплата в момент передачи предмета расчёта; `5` - частичная оплата предмета расчёта в момент его передачи с последующей оплатой в кредит; `6` - передача предмета расчёта без его оплаты в момент его передачи с последующей оплатой в кредит; `7` - оплата предмета расчёта после его передачи с оплатой в кредит. Приоритизация передачи значения происходит по следующему принципу (указано в убывающем порядке приоритета): Корзина заказа из API-запроса. Настройки фискализации в личном кабинете. Значения по умолчанию. Для paymentMethod значением по умолчанию является 1 (полная предварительная оплата до момента передачи предмета расчета).
itemAttributes[`paymentObject`]	N..2	Да	Тип оплачиваемой позиции, возможны следующие значения: `1` - товар; `2` - подакцизный товар; `3` - работа; `4` - услуга; `5` - ставка азартной игры; `6` - выигрыш азартной игры; `7` - лотерейный билет; `8` - выигрыш лотереи; `9` - предоставление РИД; `10` - платёж; `11` - агентское вознаграждение; `12` - составной предмет расчёта; `13` - иной предмет расчёта; `14` - имущественное право; `15` - внереализационный доход; `16` - страховые взносы: о суммах расходов, уменьшающих сумму налога (авансовых платежей) в соответствии с пунктом 3.1 статьи 346.21 Налогового кодекса Российской Федерации; `17` - торговый сбор: о суммах уплаченного торгового сбора; `18` - курортный сбор; Указанные выше значения доступны для ФФД 1.05. Для ФФД 1.2 список доступных значений пополняется также следующими значениями: `30` - реализуемый подакцизный товар, подлежащий маркировке средством идентификации, не имеющем кода маркировки; `31` - реализуемый подакцизный товар, подлежащий маркировке средством идентификации, имеющем кода маркировки; `32` - реализуемый товар, подлежащий маркировке средством идентификации, не имеющим код маркировки, за исключением подакцизного товара; `33` - реализуемый товар, подлежащий маркировке средством идентификации, имеющим код маркировки, за исключением подакцизного товара. Приоритизация передачи значения происходит по следующему принципу (указано в убывающем порядке приоритета): Корзина заказа из API-запроса. Настройки фискализации в личном кабинете. Значения по умолчанию. Для paymentObject значением по умолчанию является 1 (товар).
`taxType`	N..2	Да	Ставка НДС, доступны следующие значения: `0` – без НДС; `1` – НДС по ставке 0%; `2` – НДС чека по ставке 10%; `4` – НДС чека по расчетной ставке 10/110; `6` – НДС чека по ставке 20%; `7` – НДС чека по расчётной ставке 20/120; `10` – НДС чека по ставке 5%; `11` – НДС чека по расчетной ставке 5/105; `12` – НДС чека по ставке 7%; `13` – НДС чека по расчетной ставке 7/107. Если в запросе не передаётся корзина с данными фискализации, оператору фискальных данных передаются значения по умолчанию, указанные в настройках личного кабинета (подробнее см. инструкцию по работе с личным кабинетом).

Содержимое блока loyalties

Название	Тип	Обязательно	Описание	Версия getOrderStatusExtended
`loyaltyProgramName`	ANS..20	Да	Условное наименование бонусной программы, в которой участвует товарная позиция, выдаётся платёжным шлюзом.	32 и выше.
`positionId`	ANS..12	Да	Идентификатор товарной позиции, участвующей в указанной бонусной программе.	32 и выше.
`bonusAmountForDebit`	N..18	Да	Общая сумма бонусов всех товарных позиций для данного `positionId` к списанию, указывается в копейках.	32 и выше.
`bonusAmountForCredit`	N..18	Нет	Общая сумма бонусов всех товарных позиций для данного `positionId` к начислению, указывается в копейках.	32 и выше.
`bonusAmountRefunded`	N..18	Нет	Общая сумма бонусов всех товарных позиций для данного `positionId` к возврату.	32 и выше.

Коды ошибок

В ответ на запрос платежный шлюз возвращает информацию об ошибках, содержащую errorCode и errorMessage.

errorCode - информационный параметр в случае ошибки, который может иметь разные кодовые значения:

значение 0 - указывает на успех обработки запроса;
другое числовое значение (1-99) - указывает на ошибку, для получения более подробной информации о которой необходимо проверить параметр errorMesage.

Код ошибки	Текст ошибки
0	Обработка запроса прошла без системных ошибок.
5	Доступ запрещён.
5	Пользователь должен сменить свой пароль.
5	`[orderId]` не задан.
6	Незарегистрированный `orderId`.
7	Системная ошибка.

Полный список кодов ошибок размещен здесь.

Примеры

Пример запроса POST

orderId=b9054496-c65a-4975-9418-1051d101f1b9&language=ru&merchantOrderNumber=0784sse49d0s134567890

Пример ответа

{"errorCode":"0","errorMessage":"Успешно","orderNumber":"0784sse49d0s134567890","orderStatus":6,"actionCode":-2007,"actionCodeDescription":"Время сессии истекло","amount":33000,"currency":"643","date":1383819429914,"orderDescription":" ","merchantOrderParams":[{"name":"email","value":"yap"}],"attributes":[{"name":"mdOrder","value":"b9054496-c65a-4975-9418-1051d101f1b9"}],"cardAuthInfo":{"expiration":"201912","cardholderName":"Ivan","secureAuthInfo":{"eci":6,"threeDSInfo":{"xid":"MDAwMDAwMDEzODM4MTk0MzAzMjM="}},"pan":"411111**1111"},"terminalId":"333333"}

Пример ответа на запрос getOrderStatusExtended 24 версии

{"errorCode":"0","errorMessage":"Успешно","orderNumber":"41020","orderStatus":1,"actionCode":0,"actionCodeDescription":"","amount":9223622,"currency":"643","date":1658497112784,"orderDescription":"тест","ip":"10.99.50.37","merchantOrderParams":[{"name":"loyaltyId","value":"sbrf_spasibo"},{"name":"sbrf_spasibo:amount_bonus","value":"1013400"},{"name":"sbrf_spasibo:change_rate","value":"1"},{"name":"pageName","value":"rbs"}],"transactionAttributes":[{"name":"merchantIp","value":"10.99.50.37"},{"name":"paymentNetRefNum","value":"c49b6fe5-50fe-4849-a962-285e073f971c"}],"attributes":[{"name":"mdOrder","value":"56cc6340-5878-772e-952d-1197489344f9"}],"cardAuthInfo":{"maskedPan":"427601**6064","expiration":"202412","cardholderName":"qqq","approvalCode":"123456","paymentSystem":"VISA","pan":"427601**6064"},"authDateTime":1658497128767,"terminalId":"123456","authRefNum":"932936841054","paymentAmountInfo":{"paymentState":"APPROVED","approvedAmount":9223622,"depositedAmount":0,"refundedAmount":0,"feeAmount":0,"totalAmount":9223622},"bankInfo":{"bankName":"Sberbank Of Russia","bankCountryCode":"RU","bankCountryName":"Россия"},"orderBundle":{"cartItems":{"items":[{"positionId":"1","name":"Минеральная вода Росинка","quantity":{"value":40.0,"measure":"0"},"itemAmount":1153288,"depositedItemAmount":1153288,"itemCurrency":643,"itemCode":"voda"},{"positionId":"2","name":"Шок. батончик Азарт","quantity":{"value":9.0,"measure":"0"},"itemAmount":8004637,"depositedItemAmount":8004637,"itemCurrency":643,"itemCode":"shock"},{"positionId":"3","name":"Картофель","quantity":{"value":6.543,"measure":"0"},"itemAmount":65697,"depositedItemAmount":65697,"itemCurrency":643,"itemCode":"kartoshka"}]},"loyalties":{"loyalties":[{"bonusAmountForDebit":126712,"bonusAmountForCredit":0,"loyaltyProgramName":"sbrf_spasibo","positionId":"1"},{"bonusAmountForDebit":879470,"bonusAmountForCredit":0,"loyaltyProgramName":"sbrf_spasibo","positionId":"2"},{"bonusAmountForDebit":7218,"bonusAmountForCredit":0,"loyaltyProgramName":"sbrf_spasibo","positionId":"3"}]}},"loyaltyInfos":[{"loyaltyName":"sbrf_spasibo","paymentBonus":{"approvedAmountBonus":1013400,"depositedAmountBonus":1013400,"refundedAmountBonus":0,"pcId":"1002780105","successful":true,"paymentOperation":"PAYMENT"},"awardBonus":{"approvedAmountAward":0,"depositedAmountAward":0,"refundedAmountAward":0,"successful":false}}],"chargeback":false,"paymentWay":"CARD",
"ofdOrderBundle":[
{"taxType":"VAT_20","name":"Картофель","itemAmount":12681,"itemPrice":10040,"quantity":{"value":1.263,"measure":"0"}},
{"taxType":"VAT_20","name":"Картофель","itemAmount":53016,"itemPrice":10041,"quantity":{"value":5.28,"measure":"0"}},
{"taxType":"VAT_20","name":"Минеральная вода Росинка","itemAmount":922624,"itemPrice":28832,"quantity":{"value":32.0,"measure":"0"}},
{"taxType":"VAT_20","name":"Минеральная вода Росинка","itemAmount":230664,"itemPrice":28833,"quantity":{"value":8.0,"measure":"0"}},
{"taxType":"VAT_20","name":"Шок. батончик Азарт","itemAmount":7115232,"itemPrice":889404,"quantity":{"value":8.0,"measure":"0"}},
{"taxType":"VAT_20","name":"Шок. батончик Азарт","itemAmount":889405,"itemPrice":889405,"quantity":{"value":1.0,"measure":"0"}}]}

Инструменты страницы