Инструменты страницы
Запрос доступной программы лояльности и возможного количества бонусных баллов к списанию
Запрос getPossibleLoyalty.do позволяет запросить название программы лояльности, бонусные баллы которой можно использовать при оплате заказа, а также минимально и максимально возможное количество баллов для оплаты.
Поддерживается только POST.
В настоящем документе при описании параметров запросов и ответов используются следующие обозначения типов данных:
- 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.
Параметры запроса:
| Название | Тип | Обязательно | Описание |
|---|---|---|---|
|
|
AN..30 | Да | Логин магазина, полученный при подключении. |
|
|
AN..200 | Да | Пароль магазина, полученный при подключении. |
|
|
ANS36 | Да |
Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа не удалась по причине ошибки, детализированной в ErrorCode. |
|
|
A2 | Нет |
Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию. |
|
|
AN..255 | обязательно, если не передаётся pan |
Идентификатор связки, созданной ранее. |
|
|
N12…19 | обязательно, если не передаётся bindingId |
Номер платёжной карты. При указании в запросе параметра seToken этот параметр не обязателен к передаче. |
Параметры ответа:
| Название | Тип | Обязательно | Описание |
|---|---|---|---|
|
|
N..2 | Да |
Код ошибки. |
|
|
| Нет |
|
|
|
N..20 | Нет |
Минимальная сумма бонусных баллов, которая может быть использована при оплате заказа. |
|
|
N..20 | Нет |
Максимальная сумма бонусных баллов, которая может быть использована при оплате заказа. В рамках одного платежа пользователь не может потратить больше баллов, чем указано в этом параметре. |
|
|
AN..512 | Нет |
Код бонусной программы внутри системы. |
Коды ошибок (поле errorCode):
| Значение | Описание |
|---|---|
| 0 | Обработка запроса прошла без системных ошибок. |
| 5 | Доступ запрещён. |
| 6 | Заказ не найден. |
| 7 | Системная ошибка. |
Пример POST-запроса с передачей идентификатора связки:
orderId=cef5266d-8e44-4f4f-a86a-3a2d2d666dab&bindingId=25d02dfe-edd6-4fad-86c2-419c3a467cf2&language=ru
Пример POST-запроса с передачей номера карты:
orderId=3c52bbe4-777f-49b0-afb8-bb2b6a971f74&pan=4276010013866254&language=ru
Пример ответа:
{"errorCode":"0","loyaltyOperations":[{"serviceName":"sbrf_spasibo","minAmount":0,"maxAmount":6000}]}