Отмена/возврат финансовой операции
Обновлено 27 декабря 2023
Описание сервиса
Клиент направляет запрос на отмену/возврат финансовой операции, направляя параметры операции и сумму, на которую необходимо выполнить отмену. В ответ получает обновленный статус заказа и информацию по выполненной отмене/возврату операции.
| Описание сервиса | Процесс | URL | Инициатор | Потребитель | Синхронный |
|---|---|---|---|---|---|
| Отмена/возврат финансовой операции | QR-код ПокупателяQR-код ПродавцаQR-код СБП | /oauth: https://mc.api.sberbank.ru:443/prod/tokens/v3/oauth /cancel:https://mc.api.sberbank.ru:443/prod/qr/order/v3/cancel scope:https://api.sberbank.ru/qr/order.cancel | Клиент | Сбербанк | Да |
Параметры запроса:
Обновлено 27 декабря 2023
| Наименование атрибута | Mapping | Формат | Кратность | Паттерн | Описание |
| Authorization | header | string | [1] | Авторизационные данные.Заполняется значением токена доступа* (access_token) по шаблону: "Bearer" + пробел + \<access_token>"example: "Bearer f3d29241-f35c-4bfd-b0ef-5f011c993ef9" ______________________ * - процесс получения токена доступа описан на страницах: Настройки сервиса вызова API и Token 3.0.0 | |
| Accept | header | string | [0..1] | Заголовок Accept example: "*/*" | |
| Content-Type | header | string | [1] | Заголовок Content-Typeexample: "application/json" | |
| RqUID | header | string(32) | [1] | ^[0-9a-fA-F]{32}$ | Уникальный идентификатор запроса example: "d0c5d5d03e074ad7ba2e2e248eef7e9c" |
| rq_uid | body | string(32) | [1] | ^[0-9a-fA-F]{32}$ | Уникальный идентификатор запроса. example: "d0c5d5d03e074ad7ba2e2e248eef7e9c" |
| rq_tm | body | string(20) | [1] | ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$ | Дата/Время формирования запроса.example: "2005-08-15T15:52:01Z" |
| order_id | body | string(36) | [1] | ^[a-zA-Z0-9_\-\\]{1,36}$ | ID заказа (в АС Сбербанка) example: "720ade472cdd400d93e7e6a4f94e38d2" |
| operation_type | body | string(36) | [0..1] | Тип операции["REFUND", "REVERSE"] | |
| operation_id | body | string(50) | [1] | ^[a-zA-Z0-9_\-\\]{1,50}$ | Идентификатор операции (оплаты/возврата) в АС Сбербанка, которую требуется отменить. |
| auth_code | body | string(8) | [1] | ^[a-zA-Z0-9_\-\\]{1,8}$ | Код авторизации example: "00000000" |
| id_qr | body | string(36) | [1] | ^[a-zA-Z0-9_\-\\]{1,36}$ | Идентификатор устройства, на котором сформирован заказ.Правила заполнения: Правила заполнения: 1. Для операции "QR-код Продавца": IdQR (Уникальный идентификатор устройства в системе "Плати QR"); 2. Для операции "QR-код СБП": tid (Уникальный идентификатор) |
| tid | body | string(8) | [1] | ^[a-zA-Z0-9_\-\\]{1,8}$ | Уникальный идентификатор терминала |
| cancel_operation_sum | body | integer(15) | [1] | minimum: 0maximum: 999999999999999 | Сумма отмены/возврата в минимальных единицах Валюты |
| operation_currency | body | string(3) | [1] | ^[0-9]{3}$ | Валюта операции, цифровой код по ISO 4217. |
| sbp_payer_id | body | string(36) | [0..1] | ^007[0-9]{10}$ | Идентификатор Получателя. Возможные значения: Номер мобильного телефона клиента физ. лица в формате '0079001234567' |
| operation_description | body | string(140) | [0..1] | ^.*$ | Описание назначения платежа (Спец.символы требуется экранировать) |
Пример запроса OrderCancelQrRq
{
"rq_uid": "c0567a795bbd45659726288801e6b57c",
"rq_tm": "2022-03-14T12:32:57Z",
"operation_id": "ca8429884ee3481aa90ca1e8fee28307",
"operation_type": "REFUND",
"order_id": "136ab66215de4e9a81b393d138859482",
"id_qr": "1000100051",
"cancel_operation_sum": 11,
"operation_currency": "643",
"auth_code": "269025",
"tid": "20151881"
}
Параметры ответа:
| Наименование атрибута | Mapping | Формат | Кратность | Паттерн | Описание | |
| rq_uid | body | string(32) | [1] | ^[0-9a-fA-F]{32}\$ | Уникальный идентификатор запроса. example: "d0c5d5d03e074ad7ba2e2e248eef7e9c" | |
| rq_tm | body | string(20) | [1] | ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z\$ | Дата/Время формирования запроса.example: "2005-08-15T15:52:01Z" | |
| order_id | body | string(36) | [0..1] | ^[a-zA-Z0-9_\-\\]*\$ | ID заказа (в АС Сбербанка) example: "720ade472cdd400d93e7e6a4f94e38d2" | |
| order_status | body | string(20) | [0..1] | Статус заказа.enum: ["PAID", "CREATED", "REVERSED", "REFUNDED", "REVOKED", "DECLINED", "EXPIRED", "AUTHORIZED", "CONFIRMED", "ON_PAYMENT"] | ||
| operation_id | body | string(50) | [0..1] | ^[A-Za-z0-9_\\-]*\$ | Уникальный идентификатор операции в АС Сбербанка (прямой/возврата), которую необходимо отменить | |
| operation_date_time | body | string(20) | [0..1] | ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z\$ | Дата/Время созданной операции отмены/возврата.example: "2005-08-15T15:52:01Z" | |
| operation_type | body | string(36) | [0..1] | Тип операции.enum: ["PAY", "REVERSE", "REFUND"] | ||
| operation_sum | body | integer(15) | [0..1] | minimum: 0maximum: 999999999999999 | Сумма операции в минимальных единицах Валюты. | |
| operation_currency | body | string(3) | [0..1] | ^[0-9]{3}\$ | Валюта операции, цифровой код по ISO 4217. example: "643" | |
| auth_code | body | string(8) | [0..1] | ^[a-zA-Z0-9_\-\\]*\$ | Код авторизации. | |
| rrn | body | string(12) | [0..1] | ^[a-zA-Z0-9_\-\\]*\$ | RRN операции. | |
| tid | body | string(8) | [0..1] | ^[a-zA-Z0-9_\-\\]*\$ | Уникальный идентификатор терминала. | |
| id_qr | body | string(36) | [0..1] | ^[a-zA-Z0-9_\-\\]*\$ | Идентификатор устройства, на котором сформирован заказ. Правила заполнения: 1. Для операции "QR-код Продавца": IdQR (Уникальный идентификатор устройства в системе "Плати QR"); 2. Для операции "QR-код СБП": tid (Уникальный идентификатор) | |
| error_code | body | string(6) | [1] | ^[a-zA-Z0-9_\-\\]+\$ | Код выполнения запроса | |
| error_description | body | string(1024) | [0..1] | ^.*\$ | Описание ошибки выполнения запроса | |
| sbp_operation_params | body | object | [0..1] | Блок с перечнем параметров операции СБП. Передается только для операции оплаты через СБП | ||
| sbp_cancel_operation_id | body | string(50) | [1] | ^[a-zA-Z0-9_\-\\]*\$ | Идентификатор операции в СБП | |
| sbp_merchant_name | body | string(36) | [1] | ^.*\$ | Наименование юр. лица торгово-сервисного предприятия |
Пример ответа OrderCancelQrRs
{
"rq_tm": "2022-03-14T12:32:14Z",
"operation_date_time": "2022-03-14T12:32:42Z",
"operation_type": "REFUND",
"operation_currency": "643",
"tid": "20151881",
"auth_code": "054511",
"rrn": "305197054511",
"order_status": "REFUNDED",
"operation_sum": 1,
"id_qr": "1000100051",
"error_description": "",
"operation_id": "615d72c6069043ee841e35002a1b28a9",
"error_code": "000000",
"rq_uid": "6dfb018158764e93ad298638da4e39ca",
"order_id": "136ab66215de4e9a81b393d138859482"
}