Создание заказа
Обновлено 20 декабря 2023
Описание Сервиса
Клиент направляет запрос на формирование заказа в АС Сбербанка. В ответ получает присвоенный Идентификатор заказа в АС Сбербанк (впоследствии используется в качестве ключа для инициации других операций с заказом), ссылку для генерации QR кода.
| Описание сервиса | Процесс | URL | Инициатор | Потребитель | Синхронный |
|---|---|---|---|---|---|
| Создание заказа | QR-код ПродавцаQR-код СБП | /oauth:https://mc.api.sberbank.ru:443/prod/tokens/v3/oauth /creation:https://mc.api.sberbank.ru:443/prod/qr/order/v3/creation scope:https://api.sberbank.ru/qr/order.create | Клиент | Сбербанк | Да |
Параметры запроса:
| Наименование атрибута | 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] | Заголовок Acceptexample: */* | ||
| 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}\$ | Уникальный идентификатор запроса | |
| 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" | |
| member_id | body | string(8) | [1] | \^[a-zA-Z0-9_\-\\]{1,8}\$ | Идентификатор клиента | |
| order_number | body | string(36) | [1] | \^.{1,36}\$ | Номер заказа в CRM Клиента | |
| order_create_date | 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_params_type | body | array of object | [0..1] | Описание блока с параметрами заказа | ||
| position_name | body | string(256) | [1] | \^.*\$ | Наименование товарной позиции (Спец.символы требуется экранировать) | |
| position_count | body | integer(6) | [0..1] | minimum: 0 maximum: 999999 | Количество штук товарной позиции | |
| position_sum | body | integer(15) | [0..1] | minimum: 0 maximum: 999999999999999 | Сумма товарной позиции в минимальных единицах валюты | |
| position_description | body | string(512) | [0..1] | \^.*\$ | Описание товарной позиции (Спец.символы требуется экранировать) | |
| id_qr | body | string(36) | [1] | \^[a-zA-Z0-9_\-\\]{1,36}\$ | Идентификатор устройства, на котором сформирован заказ.Правила заполнения: Здесь был список, таблицы списки не поддерживают | |
| order_sum | body | integer(15) | [1] | minimum: 0 maximum: 999999999999999 | Сумма заказа в минимальных единицах Валюты | |
| currency | body | string(3) | [1] | \^[0-9]{3}\$ | Валюта операции, цифровой код по ISO 4217example: "643" | |
| description | body | string(256) | [0..1] | \^.*\$ | Описание заказа (Спец.символы требуется экранировать) Для заказа СБП значение ограничено 140 символами: pattern \^ [A-Za-zА-Яa-я0-9' '!"#\$%&'()*+,-.\/\:;\<=>?@[\]\^_`{|}~]{140} | |
| sbp_member_id | body | string(12) | [0..1] | Идентификатор банка-участника "ПАО СберБанк" в СБП. Используется в случае проведения операции через платежную систему СБП/НСПК. Константа: "100000000111"enum: ["100000000111"] |
Пример запроса OrderCreateQrRq
{
"rq_uid": "{{rquid}}",
"rq_tm": "2022-03-14T17:37:70Z",
"member_id": "00000001",
"order_number": "2872489347704",
"order_create_date": "2021-12-08T08:16:01Z",
"order_params_type": [
{
"position_name": "Water StillWater",
"position_count": 2,
"position_sum": 10000,
"position_description": "Water Still"
}
],
"id_qr": "1000100051",
"order_sum": 20000,
"currency": "643",
"description": "описание заказа"
}
Пример запроса OrderCreateQrRq для СБП:
{
"rq_uid": "06724f00e6fc4dbdbb866631e1e385df",
"rq_tm": "2022-04-04T14:28:22Z",
"member_id": "00000001",
"order_number": "1288986419034",
"order_create_date": "2022-04-04T14:28:22Z",
"order_params_type": [
{
"position_name": "Water Still",
"position_count": 2,
"position_sum": 10,
"position_description": "Water Still"
}
],
"id_qr": "20188357",
"order_sum": 3,
"currency": "643",
"description": "Товар со склада",
"sbp_member_id": "100000000111"
}
Параметры ответа:
| Наименование атрибута | 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" |
| order_number | body | string(36) | [0..1] | \^[A-Za-z0-9_\\-]*\$ | Номер заказа в CRM Клиента |
| order_id | 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_form_url | body | string(256) | [0..1] | \^http(s?):\\/\\/.+\$ | Ссылка на считывание QR code |
| error_code | body | string(6) | [1] | \^[A-Za-z0-9_\\-]+\$ | Код выполнения запроса |
| error_description | body | string(1024) | [0..1] | \^.*\$ | Описание ошибки выполнения запроса |
Пример ответа OrderCreateQrRs
{
"rq_tm": "2022-03-14T17:37:70Z",
"order_number": "2872489347704",
"order_form_url": "https://sberbank.ru/qr/?dynamicQr=dd1991d98e244131a9dd412d27b89464",
"error_code": "000000",
"rq_uid": "ab559d5b79cb4c2293d4825815cac66b",
"order_id": "dd1991d98e244131a9dd412d27b89464",
"order_state": "CREATED"
}
Пример ответа OrderCreateQrRs для СБП
{
"rq_tm": "2022-04-04T14:28:22Z",
"order_number": "1288986419034",
"order_form_url": "https://qr.nspk.ru/AD10001BJPGUR9P18FHR8H8QLFMLV8SH?type=02&bank=100000000111&sum=3&cur=RUB&crc=1ABE",
"error_code": "000000",
"rq_uid": "06724f00e6fc4dbdbb866631e1e385df",
"order_id": "162598d6613e4ffcad49bc74013b65ba",
"order_state": "CREATED"
}