Charge - Списание заблокированных средств
Запрос выполняется командой Charge.
Запрос используется для списания денежных средств с карты Пользователя, предварительно заблокированных командой Block.
Результатом обработки запроса является списание заблокированной суммы с карты Пользователя. Списание может быть произведено на сумму меньшую, чем сумма заблокированных ранее средств. Списание по заказу может быть выполнено только один раз.
Внимание: для успешного списания необходимо, чтобы на момент исполнения запроса платеж имел статус Authorized
Название |
Описание |
Формат |
Обязательный1 |
key |
Идентификатор Продавца. Выдается с параметрами тестового/боевого доступа |
Строка |
|
map_order_id |
Идентификатор платежа в системе theMAP |
Строка (максимум 50 символов) |
|
amount |
Сумма блокировки в минимальных единицах валюты (копейках) |
Целое число |
|
split |
Используется для разделение суммы произведенного списания на составные части для последующих расчетов с контрагентами. Общая сумма всех составных частей должна соответствовать amount |
Массив объектов |
|
├─ split_terminal_id 2 |
Номер терминала для проведения операции |
Число |
|
├─ amount 2 |
Сумма разделения |
Число |
|
├─ purpose 2 |
Описание |
Строка |
|
├─ fee 2 |
Размер комиссии |
Число |
|
1 Требования обязательности параметров одинаковы для каналов оплаты: eCom
, AP
, GP
2 При передаче split
параметр обязательный
Пример передачи split
:
"split": [{"split_terminal_id": 1,"amount": 150,"purpose": "Test1","fee": 10},{"split_terminal_id": 2,"amount": 150,"purpose": "Test2","fee": 10}]
Название |
Описание |
Формат |
Обязательный1 |
Key |
Идентификатор Продавца. Выдается Продавцу с параметрами тестового/боевого доступа |
Строка |
|
OrderId |
Идентификатор платежа в системе Продавца |
Строка (максимум 50 символов) |
|
Amount |
Сумма блокировки в минимальных единицах валюты (копейках) |
Целое число |
|
Split |
Используется для разделение суммы произведенного списания на составные части для последующих расчетов с контрагентами |
Строка, содержащая группы пар ключ-значение, где группы содержатся в фигурных скобках {}, пары ключ-значение разделены символом «,» (запятая). Ключ и значение разделены символом «:» (двоеточие). Строка обособляется прямоугольными скобками «[]». Параметры ключей и значений выдаются Продавцу с параметрами тестового/боевого доступа. Общая сумма всех составных частей должна соответствовать Amount |
|
├─ split_terminal_id 2 |
Номер терминала для проведения операции |
Число |
|
├─ amount 2 |
Сумма разделения |
Число |
|
├─ purpose 2 |
Описание |
Строка |
|
├─ fee 2 |
Размер комиссии |
Число |
|
1 Требования обязательности параметров одинаковы для каналов оплаты: eCom
, AP
, GP
2 При передаче Split
параметр обязательный
Пример передачи Split
:
"Split": [{"split_terminal_id": 1,"amount": 150,"purpose": "Test1","fee": 10},{"split_terminal_id": 2,"amount": 150,"purpose": "Test2","fee": 10}]
Пример запроса 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'
Название |
Описание |
Формат |
Обязательный1 |
Success |
Флаг успешности операции |
true/false |
|
OrderId |
Идентификатор платежа в системе Продавца |
Соответствует переданному в запросе |
|
Amount |
Списанная сумма |
Соответствует переданному в запросе |
2 |
ErrCode |
Описание ошибки |
см. коды ошибок |
3 |
ErrMessage |
Опциональный параметр. Дополнительное описание ошибки |
Строка |
|
CustomParams |
Параметр является опциональным. Список дополнительных параметров операции |
Соответствует Params, переданному в запросе Block |
|
FeePercent |
Ставка комиссии за эквайринг |
Число |
|
TerminalID |
ID терминала в системе MAP, по которому фактически выполнена операция |
Число |
|
RRN |
RRN операции |
Строка |
|
BankName |
Наименование Банка-эмитента |
Строка |
|
Key |
Идентификатор Продавца. Соответствует переданному в запросе |
Строка |
|
ProcessingResponse |
Оригинальный отказ эквайера |
Строка |
|
ReceiptId |
Идентификатор чека (ФЗ54) |
Строка |
|
1 Требования обязательности параметров одинаковы для каналов оплаты: eCom
, AP
, GP
2 Передаётся, если в ответе Success=true
3 Передаётся, если в ответе Success=false
Пример ответа на успешный запрос:
{
"Success": true,
"OrderId": "TestOrder123",
"Key": "TestTerminal",
"Amount": 300,
"ErrCode": ""
}
Пример ответа на не успешный запрос:
{
"Success": false,
"OrderId": "TestOrder123",
"Key": "TestTerminal",
"Amount": 0,
"ErrCode": "ILLEGAL_ORDER_STATE"
}