getState - Получение статуса платежа
Выполняется с помощью команды getState.
Этот запрос позволяет получить информацию об актуальном состоянии транзакции (платежа).
Название |
Описание |
Формат |
Обязательный |
Key |
Идентификатор Продавца. Выдается Продавцу с параметрами тестового/боевого доступа |
Строка |
Да |
OrderId* |
Уникальный идентификатор платежа в системе theMAP |
Строка (максимум 50 символов) |
Да |
SessionOrderId* |
Идентификатор платежа в системе Продавца |
Строка (максимум 50 символов) |
Да |
*в запросе передается один из этих параметров
Пример запроса POST:
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'
Название |
Описание |
Формат |
Success |
Флаг успешности операции |
true/false |
ErrCode |
Описание ошибки. Передается пустой, если «Success=true» |
см. коды ошибок |
ErrMessage |
Опциональный параметр. Дополнительное описание ошибки |
Строка |
OrderId |
Идентификатор платежа в системе Продавца |
Строка |
Amount |
Сумма заказа в минимальных единицах валюты (копейках) |
Цифры, не содержащие десятичных или других разделителей |
State |
Состояние платежа.Передается, если «Success=true» |
Возможные значения см. в разделе Статусы заказов |
MerchantOrderId |
Уникальный идентификатор платежа в системе theMAP |
Строка |
CustomParams |
Параметр является опциональным. Список дополнительных параметров операции |
Соответствует Params, переданному в запросе Block или Charge (или Params из запроса Init) |
FeePercent |
Параметр является опциональным. Ставка комиссии за эквайринг, в десятых долях от числа. Передается пустой, если «Success=false» |
Число |
TerminalID |
Параметр является опциональным. Id терминала в системе MAP, по которому фактически выполнена операция |
Число |
AuthCode |
Параметр является опциональным. Код авторизации |
Строка (максимум 6 символов) |
Fee |
Параметр является опциональным. Сумма комиссии за эквайринг |
Число |
CardHolder |
Параметр является опциональным. ФИО держателя карты |
Число |
CardType |
Параметр является опциональным. Тип карты |
Число |
Пример ответа на успешный запрос:
{
"Success": true,
"OrderId": "TestOrder123",
"State": "Charged",
"Amount": 300,
"MerchantOrderId": "1IPAaOFn24UijYp6xqwmx"
}
Пример ответа на не успешный запрос:
{
"Success": false,
"OrderId": "",
"State": "",
"Amount": 0,
"ErrCode": "NOT_FOUND"
}