api/reverse - Отмена операции оплаты

Описание

HTTP‑метод: POST
URL: /api/reverse
Форма взаимодействия: Сервер-сервер
Формат тела запроса: application/json
Назначение: отмена операции оплаты.

URL

URLPATH

https://gateway-docs.wallet.kvell.group/api/reverse

/api/reverse

Структура запроса

Поле	Тип	Обяз.	Описание
`terminal`	`str`	✔	Уникальный идентификатор учетной записи ТСП в ПЦ.
`order_id`	`int`	✔	Уникальный идентификатор Заказа в ПЦ, полученный по результатам Запроса api/register.
`amount`	`int`	✔	Сумма Возврата или Отмены в минимальных единицах валюты. Для рублей - копейки.
`currency`	`int`	✔	Код валюты по ISO4217 (643 для RUB; 978 для EUR; 840 для USD).
`signature`	`str`	✔	Цифровая подпись запроса. Алгоритм расчёта — см. Формирование подписи.
Необязательные параметры
`unique_key`	`str`		Ключ уникальности запроса. Генерируется на стороне ТСП. При получении ключа ПЦ выполняет проверку на наличие дубликата среди обрабатываемых запросов и созданных операций. Формат: допустимы цифры [0-9], латинские буквы [a-zA-Z], дефис и нижнее подчеркивание [-_].

Структура ответа

Поле	Тип	Обяз.	Описание
`order_id`	`int`	✔	Идентификатор заказа в ПЦ. Пример: `1009982`
`order_status`	`str`	✔	Статус заказа. Пример: `REGISTERED`
`client_id`	`str`	✔	Номер заказа на стороне ТСП. Пример: `test`
`tx_id`	`int`	✔	Идентификатор операции в ПЦ. Пример: `5587788`
`tx_completed_at`	`datetime`	✔	Дата и время совершения операции в ПЦ (`YYYY.MM.DD HH:MM:SS`). Пример: `2024.01.28 00:23:19`
`tx_type`	`str`	✔	Тип операции. Пример: `P2PTRANSFER`
`tx_status`	`str`	✔	Статус операции. Пример: `APPROVED`
`tx_reason_code`	`int`	✔	Код ответа на операцию ПЦ. Пример: `1`
`message`	`str`		Краткое описание кода ответа на операцию ПЦ. Пример: `Successful financial transaction`
`amount`	`int`	✔	Сумма операции в минимальных единицах валюты (для RUB — копейки). Пример: `100`
`currency`	`int`		Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD). Пример: `643`
`tx_approval_code`	`str`	✔	Код авторизации, полученный в Банке на данную операцию. Пример: `122004`
`terminal_id`	`str`	✔	Уникальный идентификатор учётной записи ТСП в ПЦ. Пример: `893`
`bin_issuer`	`str`		Идентификационный номер банка-Эмитента. Пример: `JOINT STOCK COMMERCIAL BANK MOSCOW INDUSTRIAL BANK`
`expdate`	`str`		Дата истечения срока действия карты. Пример: `10/2024`
`iso`	`int`		Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD). Пример: `643`
`payment_system`	`str`	✔	Платёжная система. Возможные значения: 0 (по умолчанию) — не установлена; 1 — Visa; 2 — MasterCard; 8 — Maestro; 10 – MIR; 11 — СБП; 12 — Uzcard; 13 — JCB; 14 — оплата со счёта мобильного телефона; 16 — HUMO; 17 — CHUP. Пример: `2`
`rrn`	`str`	✔	RRN банковской транзакции. Пример: `33147812`
`bank_terminal_id`	`str`	✔	Идентификатор банковского терминала. Пример: `POS_1`
`ofd_state`	`str`	✔	Статус обработки платежа онлайн-кассой. Пример: `APPROVED`
`signature`	`str`		Цифровая подпись сообщения. Пример: `8f2a1c9e3b7d4056a1f8c2e9d3b6a70158fce29b4d7a1e6c0938fa2d17bc45e9`

Пример ответов

Успех (200)Пример ошибки (404)

{
    "order_id": 1009982,
    "order_status": "REGISTERED",
    "client_id": "test",
    "tx_id": 5587788,
    "tx_completed_at": "2024.01.28 00:23:19",
    "tx_type": "P2PTRANSFER",
    "tx_status": "APPROVED",
    "tx_reason_code": 1,
    "message": "Successful financial transaction",
    "amount": 100,
    "currency": 643,
    "tx_approval_code": "122004",
    "terminal_id": "893",
    "bin_issuer": "JOINT STOCK COMMERCIAL BANK MOSCOW INDUSTRIAL BANK",
    "expdate": "10/2024",
    "iso": 643,
    "payment_system": "2",
    "rrn": "33147812",
    "bank_terminal_id": "POS_1",
    "ofd_state": "APPROVED",
    "signature": "8f2a1c9e3b7d4056a1f8c2e9d3b6a70158fce29b4d7a1e6c0938fa2d17bc45e9"
}

{
    "error_code": "TERMINAL_NOT_FOUND",
    "technical_message": "Terminal not found",
    "timestamp": 1751976000,
    "details": null,
    "request_id": "b3b3c1f0-4b3a-4f3a-9b1a-1234567890ab"
}

Примечания

Ответ может содержать ряд необязательных параметров, которые важно учесть при составлении подписи.