Charge - Списание заблокированных средств
Запрос выполняется командой Charge.
Запрос используется для списания денежных средств с карты Пользователя, предварительно заблокированных командой Block.
Результатом обработки запроса является списание заблокированной суммы с карты Пользователя. Списание может быть произведено на сумму меньшую, чем сумма заблокированных ранее средств. Списание по заказу может быть выполнено только один раз.
Внимание: для успешного списания необходимо, чтобы на момент исполнения запроса платеж имел статус Authorized
Название |
Описание |
Формат |
Обязательный |
key |
Идентификатор Продавца. Выдается Продавцу с параметрами тестового/боевого доступа |
Строка |
Да |
map_order_id |
Идентификатор платежа в системе theMAP |
Строка (максимум 50 символов) |
Да |
amount |
Сумма блокировки в минимальных единицах валюты (копейках) |
Целое число |
Да |
Название |
Описание |
Формат |
Обязательный |
Key |
Идентификатор Продавца. Выдается Продавцу с параметрами тестового/боевого доступа |
Строка |
Да |
OrderId |
Идентификатор платежа в системе theMAP |
Строка (максимум 50 символов) |
Да |
Amount |
Сумма списания в минимальных единицах валюты (копейках) |
Целое число |
Да |
Пример запроса POST:
Content-Type: application/json
https:{domain}/Charge
{
"key": "TestTerminal",
"map_order_id": "TestOrder123",
"amount": 300
}
Пример реализации запроса в программном коде:
curl -X POST \
https:https:{domain}/Charge \
-H 'Content-Type: application/json' \
-d '{"key": "NewAPI","map_order_id": "1579860051","amount": 2000}'
Пример запроса POST:
Content-Type: application/x-www-form-urlencoded
https:{domain}/Charge
Key:TestTerminal
Amount:300
OrderId:TestOrder123
Пример реализации запроса в программном коде:
curl -X POST \
https:https:{domain}/Charge \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'Key=TestTerminal&Amount=300&OrderId=TestOrder123'
Название |
Описание |
Формат |
Success |
Флаг успешности операции |
true/false |
OrderId |
Идентификатор платежа в системе Продавца |
Соответсвует переданному в запросе |
Amount |
Списанная сумма |
Соответсвует переданному в запросе. Передается "0", если «Success=false» |
ErrCode |
Описание ошибки. Передается пустой, если «Success=true» |
см. коды ошибок |
ErrMessage |
Опциональный параметр. Дополнительное описание ошибки. Передается пустой, если «Success=true» |
Строка |
CustomParams |
Параметр является опциональным. Список дополнительных параметров операции |
Соответствует Params, переданному в запросе Block |
FeePercent |
Параметр является опциональным. Ставка комиссии за эквайринг, в десятых долях от числа |
Число |
Fee |
Параметр является опциональным. Сумма комиссии за эквайринг |
Число |
TerminalID |
Параметр является опциональным. Id терминала в системе MAP, по которому фактически выполнена операция |
Число |
RRN |
Параметр является опциональным. RRN операции |
Строка |
PANMask |
Параметр является опциональным. Маскированный номер карты в формате 123456xxxxxx1234 |
Строка |
BankName |
Параметр является опциональным. Наименование Банка-эмитента |
Строка |
Key |
Идентификатор Продавца. Соответствует переданному в запросе |
Строка |
ProcessingResponse |
Параметр является опциональным. Оригинальный отказ эквайера |
Строка |
TerminalID |
Параметр является опциональным. Id терминала в системе MAP, по которому фактически выполнена операция |
Число |
Пример ответа на успешный запрос:
{
"Success": true,
"OrderId": "TestOrder123",
"Key": "TestTerminal",
"Amount": 300,
"ErrCode": ""
}
Пример ответа на не успешный запрос:
{
"Success": false,
"OrderId": "TestOrder123",
"Key": "TestTerminal",
"Amount": 0,
"ErrCode": "ILLEGAL_ORDER_STATE"
}