Запрос отложенной регистрации бонусов Спасибо (deferredAward.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

Да

Логин служебной учётной записи продавца.

password

AN..200

Да

Пароль служебной учётной записи продавца.

token

AN..256

нет (нужно указать либо пару логин и пароль, либо токен)

Открытый ключ, который можно использовать для аутентификации при выполнении запроса. Если для аутентификации используются логин и пароль, параметр token передавать не нужно.

Чтобы получить открытый ключ, обратитесь в техническую поддержку.

orderId

ANS36

Да

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

В случае, если был передан token, то необходимо передать только orderId.

orderNumber

ANS..32

Да

Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы. Если номер заказа генерируется на стороне платёжного шлюза, этот параметр передавать необязательно

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

language

A2

Да

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

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

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

orderNumber

ANS..32

Да

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

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

orderStatus

N1

Нет

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

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

Возможен также промежуточный статус orderStatus=7. По значению это статус PENDING, который используется при завершении двухстадийных заказов, и проставляется в момент завершения оригинального заказа. Он меняется на DEPOSITED (orderStatus=2) через некоторое время, когда проводится успешная операция в процессинге по инициирующему заказу.

actionCode

ANS..6

Да

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

actionCodeDescription

AN..512

Да

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

errorCode

N..2

Нет

Код ошибки. Может отсутствовать, если результат не привёл к ошибке.

См. описание кодов ошибок ниже.

errorMessage

AN..512

Нет

Описание ошибки на языке, переданном в параметре language в запросе.

Элемент operations

operation

AN..512

Нет

Тип операции, возможны следующие значения:

  • PAYMENT;
  • AWARD;
  • REVERSE;
  • REFUND_PAYMENT;
  • REFUND_AWARD.

amount

N..20

Нет

Сумма баллов по операции

transactionId

AN..512

Нет

Идентификатор операции в платёжном шлюзе.

successful

AN..512

Нет

Признак успешности операции, возможны следующие значения:

  • true (успешно);
  • false (неуспешно).

pcId

AN..512

Нет

Идентификатор операции в процессинге лояльности.

Коды ошибок

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

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

7

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

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

username=testUsername&password=testPwd&orderId=30713439-087a-780f-8319-8f284806bca1

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

{"errorCode":"0","errorMessage":"Успешно","operations":[{"operation":"AWARD","transactionId":"BE70B59FEE9E47AF8F28B270F12154A7","amount":681,"successful":true,"pcId":1005068383}]}