Создание заказа

Обновлено 29 ноября 2024

POST

/creation

Создание заказа

Request

Header Parameters

RqUID

string

required

Возможные значения: <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

• application/json

Body

required

Тело запроса

rq_uid

string

required

Возможные значения: >= 32 characters и <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

Уникальный идентификатор запроса

rq_tm

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

Дата/Время формирования запроса

member_id

string

required

Возможные значения: <= 8 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,8}$

Идентификатор клиента

order_number

string

required

Возможные значения: <= 36 characters, Value must match regular expression ^.{1,36}$

Номер заказа в CRM Клиента

order_create_date

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

Дата/время формирования заказа

order_params_type object[]
Possible values: <= 100000
Array [
position_name
string
required
Возможные значения: <= 256 characters, Value must match regular expression ^.*$
Наименование товарной позиции
position_count
integer
Возможные значения: >= 0 и <= 999999
Количество штук товарной позиции
position_sum
integer
Возможные значения: >= 0 и <= 999999999999999
Сумма товарной позиции в минимальных единицах валюты
position_description
string
Возможные значения: <= 512 characters, Value must match regular expression ^.*$
Описание товарной позиции
]
id_qr

string

required

Возможные значения: <= 36 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,36}$

IdQR устройства или tid Уникальный идентификатор терминала для СБП, на котором сформирован заказ

order_sum

integer

required

Возможные значения: >= 0 и <= 999999999999999

Сумма заказа в минимальных единицах Валюты

currency

string

required

Возможные значения: <= 3 characters, Value must match regular expression ^[0-9]{3}$

Валюта операции, цифровой код по ISO 4217

description

string

Возможные значения: <= 256 characters, Value must match regular expression ^.*$

Описание заказа

sbp_member_id

string

Возможные значения: <= 12 characters, [100000000111, 110000000111]

Идентификатор банка-участника ПАО СберБанк в СБП. Используется в случае проведения операции через платежную систему СБП/НСПК. Константа: 100000000111 (добавляется в API v3.0.0)

Ответы

• 200
• 400
• 401
• 403
• 404
• 405
• 429
• 500
• 503
• 504

200 OK

• application/json

• Схема
• Пример из схемы

Schema

rq_uid

string

required

Возможные значения: >= 32 characters и <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

Уникальный идентификатор запроса

rq_tm

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

Дата/Время формирования запроса

order_number

string

Возможные значения: <= 36 characters, Value must match regular expression ^.*$

Номер заказа в CRM Клиента

order_id

string

Возможные значения: <= 36 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

ID заказа в АС ППРБ.Карты

order_state

string

Возможные значения: <= 20 characters, [PAID, CREATED, REVERSED, REFUNDED, REVOKED, DECLINED, EXPIRED, ON_PAYMENT]

Статус заказа

order_form_url

string

Возможные значения: <= 256 characters, Value must match regular expression ^http(s?):\/\/.+$

Ссылка на считывание QR code

error_code

string

required

Возможные значения: <= 6 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

Код выполнения запроса

error_description

string

Возможные значения: <= 1024 characters, Value must match regular expression ^.*$

Описание ошибки выполнения запроса

{
  "rq_uid": "d0c5d5d03e074ad7ba2e2e248eef7e9c",
  "rq_tm": "2005-08-15T15:52:01Z",
  "order_number": "Номер заказа в CRM Клиента",
  "order_id": "d1c3d5d93e094ad7ba3e5e248eef7e3c",
  "order_state": "PAID",
  "order_form_url": "https://example.com",
  "error_code": "123456",
  "error_description": "Описание ошибки выполнения запроса"
}

Client Error 400 Bad Request (Запрос не корректен)'

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

Возможные значения: Value must match regular expression ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Client Error 401 Unauthorized (Приложение не авторизовано, либо некорректное значение client-id)

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

Возможные значения: Value must match regular expression ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Forbidden

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

Возможные значения: Value must match regular expression ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Not Found

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

Возможные значения: Value must match regular expression ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Method Not Allowed (Ошибка API gateway, не найдены операци и, поддерживающие запрошенную http-команду)

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

Возможные значения: Value must match regular expression ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Too Many Requests (Превышен лимит отправляемых запросов)

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

Возможные значения: Value must match regular expression ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Internal Server Error (Внутренняя ошибка сервера

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

Возможные значения: Value must match regular expression ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Service Unavailable (Операция не доступна)

Gateway Timeout

Loading...

Loading...