Запрос статуса заказа
Обновлено 20 декабря 2023
Описание сервиса
Клиент запрашивает информацию по ранее созданному заказу по Уникальному идентификатору запроса (ранее сформированному в АС Сбербанка) и по номеру заказа в CRM Клиента. В ответ получает данные по заказу с детализацией по финансовым операциям.
| Описание сервиса | Процесс | URL | Инициатор | Потребитель | Синхронный |
|---|---|---|---|---|---|
| Запрос статуса заказа | QR-код ПокупателяQR-код ПродавцаQR-код СБП | /oauth:https://mc.api.sberbank.ru:443/prod/tokens/v3/oauth /status:https://mc.api.sberbank.ru:443/prod/qr/order/v3/status scope:https://api.sberbank.ru/qr/order.status | Клиент | Сбербанк | Да |
Параметры запроса:
| Наименование атрибута | 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) | [0..1] | \^[a-zA-Z0-9_\-\\]*\$ | Номер заказа (в бэк системе Сбербанка) |
| tid | body | string(8) | [1] | \^[a-zA-Z0-9_\-\\]{1,8}\$ | Уникальный идентификатор терминала |
| partner_order_number | body | string(36) | [1] | \^.{1,36}\$ | Номер заказа в CRM Клиента |
Пример запроса OrderStatusRequestQrRq
{
"rq_uid": "458289cc2d2c4e40931ce4949f48748f",
"rq_tm": "2022-03-14T12:26:03Z",
"order_id": "136ab66215de4e9a81b393d138859482",
"tid": "20151881",
"partner_order_number": "456"
}
Параметры ответа:
| Наименование атрибута | Mapping | Формат | Кратность | Паттерн | Описание | |
| rq_uid | body | string(32) | [1] | \^[0-9a-fA-F]{32}\$ | Уникальный идентификатор запроса | |
| 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" | |
| mid | body | string(15) | [0..1] | \^[a-zA-Z0-9_\-\\]*\$ | Уникальный идентификатор Торговой точки | |
| 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 (Уникальный идентификатор) | |
| order_id | body | string(36) | [0..1] | \^[a-zA-Z0-9_\-\\]*\$ | ID заказа (в бэк системе Сбербанка) | |
| order_state | body | string(20) | [0..1] | Статус заказаenum: ["PAID", "CREATED", "REVERSED", "REFUNDED", "REVOKED", "DECLINED", "EXPIRED", "AUTHORIZED", "CONFIRMED", "ON_PAYMENT"] | ||
| order_operation_params | body | array of object | [0..1] | Блок с перечнем операций, привязанных к данному заказу с детализацией по каждой операции. | ||
| operation_id | body | string(50) | [1] | \^[a-zA-Z0-9_\-\\]+\$ | Идентификатор операции (в АС Сбербанка) | |
| operation_date_time | 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" | |
| rrn | body | string(12) | [1] | \^[a-zA-Z0-9_\-\\]+\$ | RRN операции example: "123456123456 " | |
| operation_type | body | string(36) | [1] | Тип операцииenum: ["PAY", "REVERSE", "REFUND"] | ||
| operation_sum | body | integer(15) | [1] | minimum: 0 maximum: 999999999999999 | Сумма операции в копейках | |
| operation_currency | body | string(3) | [1] | \^[0-9]{3}\$ | Валюта операции example: "643" | |
| auth_code | body | string(8) | [1] | \^[a-zA-Z0-9_\-\\]+\$ | Код авторизации example: "12345678" | |
| response_code | body | string(2) | [1] | \^[a-zA-Z0-9_\-\\]+\$ | Код выполнения запроса | |
| response_desc | body | string(256) | [0..1] | \^.*\$ | Описание кода выполнения запроса | |
| client_name | body | string(256) | [0..1] | \^.*\$ | Маскированное Имя Отчество Ф. плательщика | |
| sbp_operation_params | body | object | [0..1] | Блок с перечнем параметров операции СБП. Передается только для операции оплаты через СБП | ||
| sbp_operation_id | body | string(50) | [1] | \^[a-zA-Z0-9_\-\\]*\$ | Идентификатор операции в СБП example: "B105600390167601000004681598593B" | |
| sbp_masked_payer_id | body | string(36) | [1] | \^[A-Za-z0-9_\-\s\\+()/*]*\$ | Маскированный идентификатор плательщика example: "*********6731" | |
| error_code | body | string(6) | [1] | \^[A-Za-z0-9_\\-]*\$ | Код ошибки | |
| error_description | body | string (1024) | [0..1] | \^.*\$ | Описание ошибки выполнения запроса |
Пример ответа OrderStatusRequestQrRs
{
"rq_tm": "2022-03-14T12:26:03Z",
"id_qr": "1000100051",
"order_operation_params": [
{
"operation_date_time": "2022-03-14T12:17:42Z",
"response_code": "00",
"operation_sum": 1760,
"operation_type": "PAY",
"response_desc": "Оплата заказа",
"operation_id": "ca8429884ee3481aa90ca1e8fee28307",
"operation_currency": "643",
"rrn": "207388423397",
"auth_code": "269025"
}
],
"mid": "101000015310",
"error_code": "000000",
"rq_uid": "458289cc2d2c4e40931ce4949f48748f",
"order_id": "136ab66215de4e9a81b393d138859482",
"order_state": "PAID",
"tid": "20151881"
}