getState - Получение статуса платежа
Выполняется с помощью команды getState.
Этот запрос позволяет получить информацию об актуальном состоянии транзакции (платежа).
| Название |
Описание |
Формат |
Обязательный1 |
key |
Идентификатор Продавца. Выдается с параметрами тестового/боевого доступа |
Строка |
|
map_order_id |
Идентификатор платежа в системе theMAP |
Строка (максимум 50 символов) |
2 |
merchant_order_id |
Идентификатор платежа в системе Продавца |
Строка (максимум 50 символов) |
2 |
is_overload |
Синхронизация данных с банком |
true/false |
|
1 Требования обязательности параметров одинаковы для каналов оплаты: eCom, AP, GP, SBP
2 В запросе передается один из этих параметров
| Название |
Описание |
Формат |
Обязательный1 |
Key |
Идентификатор Продавца. Выдается Продавцу с параметрами тестового/боевого доступа |
Строка |
|
OrderId |
Уникальный идентификатор платежа в системе theMAP |
Строка (максимум 50 символов) |
2 |
SessionOrderId |
Идентификатор платежа в системе Продавца |
Строка (максимум 50 символов) |
2 |
IsOverload |
Синхронизация данных с банком |
true/false |
|
1 Требования обязательности параметров одинаковы для каналов оплаты: eCom, AP, GP, SBP
2 В запросе передается один из этих параметров
Пример запроса POST:
Content-Type: application/json
https:{domain}/getState
{
"key": "TestTerminal",
"merchant_order_id": "TestOrder123",
"map_order_id": "1XiBzks2BZoFOxr8Qdn2e5Vrysh"
}
Пример реализации запроса в программном коде:
curl -X POST \
https:https:{domain}/getState \
-H 'Content-Type: application/json' \
-d '{"key":"TestTerminal","map_order_id":"TestOrder123","amount":300}'
Пример запроса POST:
Content-Type: application/x-www-form-urlencoded
https:{domain}/getState
Key:TestTerminal
SessionOrderId:TestOrder123
Пример реализации запроса в программном коде:
curl -X POST \
https:https:{domain}/getState \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'Key=TestTerminal&SessionOrderId=TestOrder123'
| Название |
Описание |
Формат |
Обязательный1 |
Success |
Флаг успешности операции |
true/false |
|
OrderId |
Идентификатор платежа в системе Продавца |
Соответствует переданному в запросе |
|
Amount |
Сумма заказа в минимальных единицах валюты (копейках) |
Целое число |
2 |
AuthCode |
Код авторизации |
Строка (максимум 6 символов) |
|
ErrCode |
Описание ошибки |
см. коды ошибок |
3 |
ErrMessage |
Опциональный параметр. Дополнительное описание ошибки |
Строка |
|
PanMask |
Маскированный номер карты в формате 123456xxxxxx1234 |
Строка |
|
State |
Состояние платежа.Передается, если «Success=true» |
Возможные значения см. в разделе Статусы заказов |
|
MerchantOrderId |
Уникальный идентификатор платежа в системе theMAP |
Строка |
4 |
CustomParams |
Список дополнительных параметров операции |
Соответствует Params, переданному в запросе Block или Charge (или Params из запроса Init) |
|
CardHolder |
Параметр является опциональным. ФИО держателя карты |
Число |
|
FeePercent |
Параметр является опциональным. Ставка комиссии за эквайринг, в десятых долях от числа. Передается пустой, если «Success=false» |
Число |
|
TerminalID |
Параметр является опциональным. Id терминала в системе MAP, по которому фактически выполнена операция |
Число |
|
CardType |
Тип карты |
Строка |
|
RRN |
RRN операции |
Строка |
|
1 Требования обязательности параметров одинаковы для каналов оплаты: eCom, AP, GP, SBP
2 Передаётся, если в ответе Success=true
3 Передаётся, если в ответе Success=false
4 Передаётся, если статус Authorized или Charged и Success=true
Пример ответа на успешный запрос:
{
"Success": true,
"OrderId": "TestOrder123",
"State": "Charged",
"Amount": 300,
"MerchantOrderId": "1IPAaOFn24UijYp6xqwmx"
}
Пример ответа на не успешный запрос:
{
"Success": false,
"OrderId": "",
"State": "",
"Amount": 0,
"ErrCode": "NOT_FOUND"
}
const tag = "GetState"