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

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

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

Название	Тип	Обязательно	Описание	Версия getOrderStatusExtended
`orderNumber`	ANS..32	Да	Номер заказа в системе магазина. Необязательно только в случае подключения автоматической генерации номера заказа на шлюзе (для этого обратитесь в техническую поддержку).	Все версии.
`orderStatus`	N1	Нет	По значению этого параметра определяется состояние заказа в платёжной системе. Отсутствует, если заказ не был найден. Ниже представлен список возможных значений: `0` - заказ зарегистрирован, но не оплачен; `1` - предавторизованная сумма удержана (для двухстадийных платежей); `2` - проведена полная авторизация суммы заказа; `3` - авторизация отменена; `4` - по транзакции была проведена операция возврата; `5` - инициирована авторизация через сервер контроля доступа банка-эмитента; `6` - авторизация отклонена.	Все версии.
`actionCode`	ANS..6	Да	Код ответа процессинга. Полный перечень кодов ответов процессинга и расшифровки этих кодов размещены на отдельной странице.	Все версии.
`actionCodeDescription`	AN..512	Да	Коды ответа - цифровое обозначение результата, к которому привело обращение к системе со стороны пользователя. Полный перечень кодов ответов процессинга и расшифровки этих кодов размещены на отдельной странице.	Все версии.
`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	Нет	Учётный номер авторизации платежа, который присваивается при регистрации платежа.	02 и выше.
`refundedDate`	ANS	Нет	Дата и время возврата средств.	13 и выше.
`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	Нет	Признак наличия спасибо на связке	Все версии.
`transactionAttributes`	Элемент	Нет	Элемент `transactionAttributes`, содержит сведения о деталях заказа. `name = merchantIp`, содержит сведения об IP-адресе мерчанта `name = sbolBankInvoiceId` содержит идентификатор транзакции СБОЛ. `name = hashDpan` содержит хешированный DPAN (информация о карте Клиента), передающийся в рамках работы со SberPay (передается при наличии у Мерчанта соответствующей пермиссии).	14 и выше.
Элемент `merchantOrderParams` – присутствует в ответе, если в заказе содержатся дополнительные параметры продавца. Каждый дополнительный параметр заказа представлен в отдельном элементе `merchantOrderParams`.
`name`	AN..20	Нет	Название дополнительного параметра.	Все версии.
`value`	ANS..2000	Нет	Значение дополнительного параметра - до 2000 символов.	Все версии.
Элемент 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
Элемент `secureAuthInfo` состоит из следующих элементов (параметры `cavv` и `xid` включены в элемент `threeDSInfo`).
`eci`	N..4	Нет	Электронный коммерческий индикатор.	Все версии.
`aresTransStatus`	A1	Нет	Статус транзакции из ответа от ACS на запрос аутентификации (ARes). Передается при использовании 3DS 2.	Все версии.
`rreqTransStatus`	A1	Нет	Статус транзакции из запроса для передачи результатов аутентификации пользователя от ACS (RReq). Передается при использовании 3DS 2.	Все версии.
`threeDSProtocolVersion`	N..12	Нет	Версия протокола 3DS. Возможные значения: «1.0.2» для 3DS1; «2.1.0» для 3DS2.; «2.2.0» для 3DS2.	Все версии.
`cavv`	ANS..200	Нет	Значение проверки аутентификации владельца карты. Указано только после оплаты заказа и в случае соответствующего разрешения.	Все версии.
`xid`	ANS..80	Нет	Электронный коммерческий идентификатор транзакции. Указан только после оплаты заказа и в случае соответствующего разрешения.	Все версии.
Элемент `bindingInfo` состоит из следующих параметров.
`clientId`	ANS..255	Нет	Номер (идентификатор) клиента в системе магазина. Используется для реализации функционала связок. Может присутствовать, если магазину разрешено создание связок. Указание этого параметра при платежах по связке необходимо - в противном случае платёж будет неуспешен.	Все версии.
`bindingId`	AN..255	Нет	Идентификатор связки, созданной ранее.	Все версии.
`authDateTime`	ANS	Нет	Дата и время авторизации в формате UNIX-времени (POSIX-времени).	02 и выше.
`terminalId`	AN..10	Нет	Идентификатор терминала в процессинге, через который осуществлялась оплата.	02 и выше.
Элемент `paymentAmountInfo` состоит из следующих параметров.
`approvedAmount`	N..12	Нет	Сумма, подтверждённая к списанию.	03 и выше.
`depositedAmount`	N..12	Нет	Сумма в минимальных единицах валюты (например, в копейках), подтверждённая для списания с карты.	03 и выше.
`refundedAmount`	N..12	Нет	Сумма возврата в минимальных единицах валюты.	03 и выше.
`paymentState`	A..10	Нет	Состояние платежа.	03 и выше.
`feeAmount`	N..12	Нет	Сумма комиссии в минимальных единицах валюты.	11 и выше.
`totalAmount`	N..12	Нет	Сумма заказа + fee (комиссия, если она была использована в заказе).	18 и выше.
Элемент `bankInfo` состоит из параметров.
`bankName`	ANS..50	Нет	Наименование банка-эмитента. Для СБОЛ значение: «Sberbank»	03 и выше.
`bankCountryCode`	AN..7	Нет	Код страны банка-эмитента. Для СБОЛ значение: «RU».	03 и выше.
`bankCountryName`	AN..160	Нет	Наименование страны банка-эмитента на языке, переданном в параметре language в запросе, или на языке пользователя, вызвавшего метод, если язык в запросе не указан. Для СБОЛ значение: «Россия».	03 и выше.
Элемент `payerData` состоит из параметров.
`email`	ANS..40	Нет	Адрес электронной почты покупателя.	13 и выше.
`phone`	NS..12	Нет	Номер телефона покупателя. Всегда нужно указывать код страны, при этом можно указывать или не указывать знак + . Таким образом, допустимы следующие варианты: +79998887766; 79998887766.	13 и выше.
`postAddress`	ANS..255	Нет	Адрес доставки.	13 и выше.
Элемент `refunds` содержит информацию по возвратам. Добавляется в ответ на запрос `getOrderStatusExtended` 05 версии и выше и присутствует только, если есть возврат по заказу.
`referenceNumber`	N12	Нет	Ссылочный номер транзакции, присваиваемый платёжным шлюзом после её завершения.	05 и выше.
`actionCode`	ANS..6	Нет	Код ответа процессинга. Полный перечень кодов ответов процессинга и расшифровки этих кодов размещены на отдельной странице.	05 и выше.
`amount`	N..12	Нет	Сумма платежа в минимальных единицах валюты.	05 и выше.
`date`	ANS	Нет	Дата возврата заказа в формате YYYYMMDDHHMMSS (например, 20210729231846).	05 и выше.
`approvalCode`	AN6	Нет	Код авторизации международной платёжной системы. Поле фиксированной длины (6 символов), может содержать цифры и латинские буквы.	С 05 до 25 для НЕ карточных платежей. 26 и выше - для всех платежных методов.
`externalRefundId`	AN..30	Нет	Идентификатор возврата. При попытке повторного возврата, проверяется `externalRefundId`: если есть, то возвращается успешный ответ с данными о возврате, если нет - осуществляется возврат.	21 и выше.
Элемент `attributes` содержит сведения о номере заказа в системе платёжного шлюза.
`name`	A7	Нет	Название атрибута, всегда принимает значение `mdOrder`.	Все версии.
`value`	ANS36	Нет	Значение атрибута - номер заказа в платежной системе (уникален в пределах системы).	Все версии.

Коды ошибок

Код ошибки	Текст ошибки
1	Ожидается `[orderId]` или `[orderNumber]`.
7	Происходит процессинг данной транзакции. Пожалуйста, повторите запрос позднее.

Примеры

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

orderId=b9054496-c65a-4975-9418-1051d101f1b9&language=ru&orderNumber=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"}