Проведение платежа по QR ФЛ
Обновлено 20 декабря 2023
Описание Сервиса
Клиент направляет запрос на проведение операции оплаты c информацией по payLoad, считанному с мобильного устройства Покупателя. В АС Сбербанка создается заказ и связанная с ним операция покупки. В ответном сообщении передаются идентификационные данные заказа и детальная информация по операции покупки.
Описание сервиса | Процесс | URL | Инициатор | Потребитель | Синхронный |
---|---|---|---|---|---|
Проведение платежа по QR ФЛ | QR-код Покупателя | /oauth:https://mc.api.sberbank.ru:443/prod/tokens/v3/oauth /pay:https://mc.api.sberbank.ru:443/prod/qr/bscanc/v1/pay scope:https://api.sberbank.ru/qr/order.pay | Клиент | Сбербанк | Да |
Параметры запроса:
Наименование атрибута | 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 | [1] | Заголовок Acceptexample: "*/*" | |
Content-Type | header | string | [1] | Заголовок Content-Typeexample: "application/json" | |
x-Introspect-rquid | header | string(32) | [1] | \^(([0-9]|[a-f]|[A-F]){32})\$ | Уникальный идентификатор запроса |
X-Ibm-Client-Id | header | string | [1] | \^[a-zA-Z0-9,_ .-]+\$ | Идентификатор приложения партнера |
rq_uid | body | string(32) | [1] | \^(([0-9]|[a-f]|[A-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: "2021-03-31T10:53:01Z" |
member_id | body | string(8) | [1] | \^[A-Za-z0-9_\\-]{8}\$ | ID партнера |
partner_order_number | body | string(36) | [1] | \^[A-Za-z0-9_\\-]*\$ | Номер заказа в CRM Клиента |
tid | body | string(8) | [1] | \^[A-Za-z0-9_\\-]*\$ | Уникальный идентификатор терминала |
id_qr | body | string(20) | [1] | \^[A-Za-z0-9_\\-]*\$ | Идентификатор устройства, на котором сформирован заказ. Правила заполнения: 1. Для операции "QR-код Продавца": IdQR (Уникальный идентификатор устройства в системе "Плати QR"); 2. Для операции "QR-код СБП": tid (Уникальный идентификатор) |
pay_load | body | string(512) | [1] | \^[A-Za-z0-9:\\/\&?.=]*\$ | PayLoad, полученный при сканировании Qr кода, отображаемого Клиентом ФЛ в СБОЛ |
amount | body | integer(15) | [1] | minimum: 0 maximum: 999999999999999 | Сумма заказа в минимальных единицах Валюты |
currency | body | string(3) | [1] | \^[0-9]{3}\$ | Валюта операции. Цифровой код по ISO 4217 example: "643" |
operation_message | body | string(128) | [1] | \^*\$ | Сообщение при платеже, для отображения ТСТ (при наличии технической возможности) |
Пример запроса PayRusClientQrRq
{
"rq_uid": "bc13cA5CE261D2661d99f1fD1Bb049Ac",
"rq_tm": "2020-06-19T12:17:01Z",
"member_id": "000001",
"partner_order_number":"78477006753",
"tid":"21325622",
"id_qr": "20305",
"pay_load": "https://sberbank.ru/qr/?ClientIdQr=40ac47c5ed7944cf8e0775a398552f2c&HashId=5c10bb41a07cbc4e7ef1be9eb7ef7c608eb4fb4ff11388bb178dc0bf7a236059&TimeStamp=1592558245&online",
"amount":48000,
"currency":"643",
"operation_message":"Оплата заказа"
}
Параметры ответа:
Наименование атрибута | Mapping | Формат | Кратность | Паттерн | Описание |
---|---|---|---|---|---|
PayRusClientQRRs | body | object | [1] | ||
status | body | object | [1] | ||
rq_uid | body | string(32) | [1] | ^(([0-9] | [a-f] |
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: "2021-03-31T10:53:01Z" |
mid | body | string(15) | [0..1] | ID партнера, формируется Сбербанком при регистрации в системе | |
tid | body | string(8) | [0..1] | ^[A-Za-z0-9_\\-]*$ | Уникальный идентификатор терминала |
id_qr | body | string(20) | [0..1] | ^[A-Za-z0-9_\\-]*$ | Идентификатор устройства, на котором сформирован заказ. Правила заполнения: для операции "QR-код Продавца": IdQR (Уникальный идентификатор устройства в системе "Плати QR"); для операции "QR-код СБП": tid (Уникальный идентификатор терминала). |
partner_order_number | body | string(36) | [1] | ^[A-Za-z0-9_\\-]*$ | Номер заказа в CRM Клиента |
order_id | body | string(32) | [0..1] | ^[A-Za-z0-9_\\-]*$ | Уникальный (сквозной) ID заказа, генерируемый при проведении платежа |
order_state | body | string(20) | [0..1] | Статус заказа enum: ["PAID","CREATED","REVERSED","REFUNDED","REVOKED","DECLINED","EXPIRED","AUTHORIZED","CONFIRMED","N_PAYMENT"] | |
order_operation_params | body | object | [0..1] | Параметры заказа | |
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: "2021-03-31T10:53:01Z" |
rrn | body | string(12) | [1] | ^[A-Za-z0-9_\\-]*$ | RRN операции |
operation_type | body | string(32) | [1] | Тип операции enum: ["PAY"] | |
operation_sum | body | integer(15) | [1] | minimum: 0 maximum: 999999999999999 | Сумма операции |
operation_currency | body | string(3) | [1] | ^[0-9]*$ | Валюта операции. Цифровой код по ISO 4217 |
auth_code | body | string(8) | [1] | ^[A-Za-z0-9_\\-]*$ | Код авторизации |
response_code | body | string(2) | [1] | ^[A-Za-z0-9_\\-]*$ | Код ответа на операцию |
response_desc | body | string(256) | [0..1] | ^.*$ | Описание кода ответа |
error_code | body | string(6) | [1] | ^[A-Za-z0-9_\\-]*$ | Код выполнения запроса |
error_description | body | string(256) | [0..1] | ^.*$ | Описание ошибки выполнения запроса |
Пример ответа PayRusClientQrRs
{
"PayRusClientQRRs":{
"status":{
"rq_tm":"2020-06-19T12:17:01Z",
"id_qr":"20305",
"order_operation_params":{
"operation_date_time":"2020-06-19T12:17:59Z",
"response_code":"00",
"operation_sum":48000,
"operation_type":"PAY",
"response_desc":"",
"operation_id":"bc13cA5CE261D2661d99f1fD1Bb049Ac",
"operation_currency":"643",
"rrn":"017191333908",
"auth_code":"252470"
},
"error_description":"",
"mid":"781000066939",
"error_code":"000000",
"partner_order_number":"78477006753",
"rq_uid":"bc13cA5CE261D2661d99f1fD1Bb049Ac",
"order_id":"201221fc8a5d4a77a7be9d8b5320a4da",
"order_state":"PAID",
"tid":"21325622"
}
}
}