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

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

Для запроса состояния зарегистрированного заказа используется запрос getOrderStatusExtended.

Для подключения к тестовой службе (WSDL) используйте следующий адрес:
https://3dsec.sberbank.ru/payment/webservices/merchant-ws?wsdl.

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

  • 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.

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

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

Название Тип Обязательно Описание

orderId

ANS36

Да
(см. примечание ниже)

Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует, если регистрация заказа не удалась по причине ошибки, детализированной в errorCode.

language

A2

Нет

Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию.

merchantOrderNumber

ANS..32

Да
(см. примечание ниже)

Номер (идентификатор) заказа в системе магазина.

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

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

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

Название Тип Обязательно Описание Версия getOrderStatusExtended

orderNumber

ANS..32

Да

Номер заказа в системе магазина.

Необязательно только в случае подключения автоматической генерации номера заказа на шлюзе (для этого обратитесь в техническую поддержку).

Все версии.

orderStatus

N1

Нет

По значению этого параметра определяется состояние заказа в платёжной системе. Отсутствует, если заказ не был найден. Ниже представлен список возможных значений:

  • 0 - заказ зарегистрирован, но не оплачен;
  • 1 - предавторизованная сумма удержана (для двухстадийных платежей);
  • 2 - проведена полная авторизация суммы заказа;
  • 3 - авторизация отменена;
  • 4 - по транзакции была проведена операция возврата;
  • 5 - инициирована авторизация через сервер контроля доступа банка-эмитента;
  • 6 - авторизация отклонена.
 Все версии.

actionCode

ANS..6

Да

Код ответа процессинга. Полный перечень кодов ответов процессинга и расшифровки этих кодов размещены на отдельной странице.

Все версии.

actionCodeDescription

AN..512

Да

Расшифровка actionCode, возвращённая процессингом. Полный перечень кодов ответов процессинга и расшифровки этих кодов размещены на отдельной странице.

Все версии.

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 проверки.
 09 и выше.

spasiboAllowed

boolean

Нет

Признак наличия спасибо на связке

Все версии.
Элемент 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

Нет

Наименование банка-эмитента.

03 и выше.

bankCountryCode

AN..7

Нет

Код страны банка-эмитента.

03 и выше.

bankCountryName

AN..160

Нет

Страна банка-эмитента.

03 и выше.
Элемент payerData состоит из параметров.

email

ANS..40

Нет

Адрес электронной почты покупателя.

13 и выше.

transactionAttributes

Элемент

Нет

Элемент transactionAttributes, содержит сведения о деталях заказа.

  • name = merchantIp, содержит сведения об IP-адресе мерчанта
  • name = sbolBankInvoiceId содержит идентификатор транзакции СБОЛ.
 14 и выше.

Коды ошибок

Код ошибки Текст ошибки
1

Ожидается [orderId] или [orderNumber].

7

Происходит процессинг данной транзакции. Пожалуйста, повторите запрос позднее.

Коды ошибок

Код ошибки Текст ошибки
0

Обработка запроса прошла без системных ошибок.

5

Доступ запрещён.

5

Пользователь должен сменить свой пароль.

5

[orderId] не указан.

6

Незарегистрированный orderId.

7

Системная ошибка.

Примеры

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
    <soapenv:Header/>
    <soapenv:Body>
       <mer:getOrderStatusExtended>
          <order orderId="942e8534-ac73-4e3c-96c6-f6cc448018f7" language="en">
             <!--Optional:-->
             <merchantOrderNumber> </merchantOrderNumber>
            </order>
       </mer:getOrderStatusExtended>
    </soapenv:Body>
 </soapenv:Envelope>

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

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
       <ns1:getOrderStatusExtendedResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
          <return orderNumber="0s7a84sPe49Hdsddd0134567a0" orderStatus="2" actionCode="0" actionCodeDescription="Request processed successfully" amount="33000" currency="643" date="2013-11-13T16:51:02.785+04:00" orderDescription=" " errorCode="0" errorMessage="Success">
             <attributes name="mdOrder" value="942e8534-ac73-4e3c-96c6-f6cc448018f7"/>
             <cardAuthInfo maskedPan="411111**1111" expiration="201512" cardholderName="Ivan" approvalCode="123456"/>
             <authDateTime>2013-11-13T16:51:02.898+04:00</authDateTime>
             <terminalId>111113</terminalId>
             <authRefNum>111111111111</authRefNum>
             <paymentAmountInfo paymentState="DEPOSITED" approvedAmount="33000" depositedAmount="33000" refundedAmount="0"/>
             <bankInfo bankName="TEST CARD" bankCountryCode="RU" bankCountryName="Russian Federation"/>
          </return>
       </ns1:getOrderStatusExtendedResponse>
    </soap:Body>
 </soap:Envelope>