/v1/orders/quickpay/cpqr
Запрос на создание заказа с быстрой оплатой через Customer Presented QR (CPQR) .
После успешного запроса будет создан заказ и запущен процесс оплаты заказа выбранным платежным методом пользователя.
Request
POST
https://pay.yandex.ru/api/merchant/v1/orders/quickpay/cpqr
Production
POST
https://sandbox.pay.yandex.ru/api/merchant/v1/orders/quickpay/cpqr
Sandbox
Body
application/json
{
"billingReport": {
"branchId": "null",
"managerId": "null"
},
"cart": {
"externalId": "example",
"items": [
{
"description": "example",
"discountedUnitPrice": "123.45",
"features": null,
"productId": "example",
"quantity": null,
"receipt": null,
"skuId": "example",
"subtotal": "123.45",
"title": "example",
"total": "123.45",
"unitPrice": "123.45"
}
],
"total": {
"amount": "123.45",
"externalAmount": "123.45"
}
},
"currencyCode": "RUB",
"metadata": "example",
"orderId": "example",
"purpose": "example",
"quickpaySession": "example"
}
|
Name |
Description |
|
cart |
All of 1 type
Корзина Example
|
|
currencyCode |
Type: string Код валюты Enum: Max length: |
|
orderId |
Type: string Идентификатор заказа на стороне продавца Max length: Example: |
|
quickpaySession |
Type: string Идентификатор сессии быстрой оплаты. Генерируется в SDK Яндекс Пэй, сохраняется в QR-коде покупателя и передается в бэкенд продавца после сканирования QR-кода кассой. Max length: Example: |
|
billingReport |
All of 1 type
Информация о месте и авторе оформления заказа Example
|
|
metadata |
Type: string | null Произвольные данные по заказу для внутреннего использования Max length: Example: |
|
purpose |
Type: string | null Назначение платежа Max length: Example: |
BillingReport
|
Name |
Description |
|
branchId |
Type: string Обязательное поле только для офлайн-магазинов. Идентификатор точки продаж Default: Max length: |
|
managerId |
Type: string Обязательное поле только для офлайн-магазинов. Идентификатор менеджера Default: Max length: |
Example
{
"branchId": "null",
"managerId": "null"
}
CartItemFeatures
|
Name |
Description |
|
pointsDisabled |
Type: boolean Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар Default: |
|
tariffModifier |
Type: string Модификатор тарифа для расчета комиссии. Определяет, какой тариф будет применяться при расчете комиссии за обработку позиции в корзине. Enum: Example: |
Example
{
"pointsDisabled": false,
"tariffModifier": "VERY_LOW"
}
ItemQuantity
|
Name |
Description |
|
count |
Type: string<double> Количество товара в заказе. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example: |
|
available |
Type: string<double> Максимально доступное количество товара Example: |
Example
{
"available": "123.45",
"count": "123.45"
}
PaymentsOperator
|
Name |
Description |
|
phones |
Type: string[] Example
|
Example
{
"phones": [
"example"
]
}
TransferOperator
|
Name |
Description |
|
address |
Type: string Max length: Example: |
|
inn |
Type: string Max length: Example: |
|
name |
Type: string Max length: Example: |
|
phones |
Type: string[] Example
|
Example
{
"address": "example",
"inn": "example",
"name": "example",
"phones": [
"example"
]
}
Agent
|
Name |
Description |
|
agentType |
Type: integer Признак агента по предмету расчёта. См. значения Enum: |
|
operation |
Type: string Max length: Example: |
|
paymentsOperator |
Type: PaymentsOperator Example
|
|
phones |
Type: string[] Example
|
|
transferOperator |
Type: TransferOperator Example
|
Example
{
"agentType": 1,
"operation": "example",
"paymentsOperator": {
"phones": [
"example"
]
},
"phones": [
"example"
],
"transferOperator": {
"address": "example",
"inn": "example",
"name": "example",
"phones": [
"example"
]
}
}
MarkQuantity
|
Name |
Description |
|
denominator |
Type: integer |
|
numerator |
Type: integer |
Example
{
"denominator": 0,
"numerator": 0
}
Supplier
|
Name |
Description |
|
inn |
Type: string Max length: Example: |
|
name |
Type: string Max length: Example: |
|
phones |
Type: string[] Example
|
Example
{
"inn": "example",
"name": "example",
"phones": [
"example"
]
}
ItemReceipt
Данные для формирования чека.
|
Name |
Description |
|
tax |
Type: integer Ставка НДС. Описание значений: Ссылка. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Enum: |
|
agent |
Type: Agent Example
|
|
excise |
Type: string<double> Не должно содержать больше двух знаков после запятой. Например: 1.12, 5.1, 10, 11.00 . Example: |
|
markQuantity |
Type: MarkQuantity Example
|
|
measure |
Type: integer Описание значений: Ссылка Enum: |
|
paymentMethodType |
Type: integer Описание значений: Ссылка Enum: |
|
paymentSubjectType |
Type: integer Описание значений: Ссылка Enum: |
|
productCode |
Type: string<base64> Код товара (base64 кодированный массив от 1 до 32 байт) Example: |
|
supplier |
Type: Supplier Example
|
|
title |
Type: string Max length: Example: |
Example
{
"agent": {
"agentType": 1,
"operation": "example",
"paymentsOperator": {
"phones": [
"example"
]
},
"phones": [
"example"
],
"transferOperator": {
"address": "example",
"inn": "example",
"name": "example",
"phones": [
"example"
]
}
},
"excise": "123.45",
"markQuantity": {
"denominator": 0,
"numerator": 0
},
"measure": 0,
"paymentMethodType": 1,
"paymentSubjectType": 1,
"productCode": "example",
"supplier": {
"inn": "example",
"name": "example",
"phones": [
"example"
]
},
"tax": 1,
"title": "example"
}
RenderedCartItem
|
Name |
Description |
|
productId |
Type: string Идентификатор товара в системе продавца. В запросе каждый Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Max length: Example: |
|
quantity |
All of 1 type
Количество товара в заказе. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example
|
|
title |
Type: string Наименование товара Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Max length: Example: |
|
total |
Type: string<double> Итоговая цена позиции с учетом примененных скидок. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Важно Убедитесь, что цена за единицу товара ( Чтобы избежать ошибок, вынесите товары в отдельные позиции с разными ПримерПравильно:
Цена за единицу Неправильно:
Цена за единицу В таком случае разбейте на две позиции:
Example: |
|
description |
Type: string Описание товара Max length: Example: |
|
discountedUnitPrice |
Type: string<double> Цена за единицу товара с учётом скидок на позицию Example: |
|
features |
All of 1 type
Промо параметры товара Example
|
|
receipt |
All of 1 type
Данные для формирования чека. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example
|
|
skuId |
Type: string Уникальный id, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа. Max length: Example: |
|
subtotal |
Type: string<double> Суммарная цена за позицию без учета скидок Example: |
|
unitPrice |
Type: string<double> Полная цена за единицу товара без учетка скидки Example: |
Example
{
"description": "example",
"discountedUnitPrice": "123.45",
"features": {
"pointsDisabled": false,
"tariffModifier": "VERY_LOW"
},
"productId": "example",
"quantity": {
"available": "123.45",
"count": "123.45"
},
"receipt": {
"agent": {
"agentType": 1,
"operation": "example",
"paymentsOperator": {
"phones": [
null
]
},
"phones": [
"example"
],
"transferOperator": {
"address": "example",
"inn": "example",
"name": "example",
"phones": [
null
]
}
},
"excise": "123.45",
"markQuantity": {
"denominator": 0,
"numerator": 0
},
"measure": 0,
"paymentMethodType": 1,
"paymentSubjectType": 1,
"productCode": "example",
"supplier": {
"inn": "example",
"name": "example",
"phones": [
"example"
]
},
"tax": 1,
"title": "example"
},
"skuId": "example",
"subtotal": "123.45",
"title": "example",
"total": "123.45",
"unitPrice": "123.45"
}
CartTotal
|
Name |
Description |
|
amount |
Type: string<double> Стоимость корзины с учетом всех скидок. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example: |
|
externalAmount |
Type: string<double> Сумма внешней оплаты (сертификаты, подарочные карты, баллы лояльности). Может быть не указана, равна 0 или больше 0. Ограничения:
Example: |
Example
{
"amount": "123.45",
"externalAmount": "123.45"
}
RenderedCart
Примечание
Стоимость доставки передавайте в items как отдельный товар.
Важно
В соответствии с Федеральным законом № 283‑ФЗ «О деятельности по предоставлению сервиса рассрочки» при использовании сервиса Сплит договор о предоставлении сервиса рассрочки с пользователем обязательно должен содержать сведения об объекте рассрочки — товарах, работах, услугах или результатах интеллектуальной деятельности, оплачиваемых в Сплит.
Поэтому в запросе обязательно передавайте данные всех объектов рассрочки в корзине в параметре cart.items.
|
Name |
Description |
|
items |
Type: RenderedCartItem[] Корзина товаров, которую оплачивает покупатель. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example
|
|
total |
All of 1 type
Итоговая информация о стоимости заказа. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example
|
|
externalId |
Type: string Идентификатор корзины на стороне продавца. Max length: Example: |
Example
{
"externalId": "example",
"items": [
{
"description": "example",
"discountedUnitPrice": "123.45",
"features": {
"pointsDisabled": false,
"tariffModifier": "VERY_LOW"
},
"productId": "example",
"quantity": {
"available": "123.45",
"count": "123.45"
},
"receipt": {
"agent": {},
"excise": "123.45",
"markQuantity": {},
"measure": 0,
"paymentMethodType": 1,
"paymentSubjectType": 1,
"productCode": "example",
"supplier": {},
"tax": 1,
"title": "example"
},
"skuId": "example",
"subtotal": "123.45",
"title": "example",
"total": "123.45",
"unitPrice": "123.45"
}
],
"total": {
"amount": "123.45",
"externalAmount": "123.45"
}
}
Responses
200 OK
Body
application/json
{
"code": 200,
"data": {
"quickpayPaymentStatus": "started"
},
"status": "success"
}
|
Name |
Description |
|
data |
Type: CreateQuickpayCpqrOrderResponseData Example
|
|
code |
Type: unknown Default: |
|
status |
Type: string Default: Const: |
RenderedCartItem
|
Name |
Description |
|
productId |
Type: string Идентификатор товара в системе продавца. В запросе каждый Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Max length: Example: |
|
quantity |
All of 1 type
Количество товара в заказе. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example
|
|
title |
Type: string Наименование товара Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Max length: Example: |
|
total |
Type: string<double> Итоговая цена позиции с учетом примененных скидок. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Важно Убедитесь, что цена за единицу товара ( Чтобы избежать ошибок, вынесите товары в отдельные позиции с разными ПримерПравильно:
Цена за единицу Неправильно:
Цена за единицу В таком случае разбейте на две позиции:
Example: |
|
description |
Type: string Описание товара Max length: Example: |
|
discountedUnitPrice |
Type: string<double> Цена за единицу товара с учётом скидок на позицию Example: |
|
features |
All of 1 type
Промо параметры товара Example
|
|
pointsAmount |
Type: string<double> Количество баллов Плюса Поле только для чтения. Переданные значения будут проигнорированы. Example: |
|
receipt |
All of 1 type
Данные для формирования чека. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example
|
|
skuId |
Type: string Уникальный id, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа. Max length: Example: |
|
subtotal |
Type: string<double> Суммарная цена за позицию без учета скидок Example: |
|
unitPrice |
Type: string<double> Полная цена за единицу товара без учетка скидки Example: |
Example
{
"description": "example",
"discountedUnitPrice": "123.45",
"features": {
"pointsDisabled": false,
"tariffModifier": "VERY_LOW"
},
"pointsAmount": "123.45",
"productId": "example",
"quantity": {
"available": "123.45",
"count": "123.45"
},
"receipt": {
"agent": {
"agentType": 1,
"operation": "example",
"paymentsOperator": {
"phones": [
null
]
},
"phones": [
"example"
],
"transferOperator": {
"address": "example",
"inn": "example",
"name": "example",
"phones": [
null
]
}
},
"excise": "123.45",
"markQuantity": {
"denominator": 0,
"numerator": 0
},
"measure": 0,
"paymentMethodType": 1,
"paymentSubjectType": 1,
"productCode": "example",
"supplier": {
"inn": "example",
"name": "example",
"phones": [
"example"
]
},
"tax": 1,
"title": "example"
},
"skuId": "example",
"subtotal": "123.45",
"title": "example",
"total": "123.45",
"unitPrice": "123.45"
}
CartTotal
|
Name |
Description |
|
amount |
Type: string<double> Стоимость корзины с учетом всех скидок. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example: |
|
externalAmount |
Type: string<double> Сумма внешней оплаты (сертификаты, подарочные карты, баллы лояльности). Может быть не указана, равна 0 или больше 0. Ограничения:
Example: |
|
pointsAmount |
Type: string<double> Количество баллов Плюса Поле только для чтения. Переданные значения будут проигнорированы. Example: |
Example
{
"amount": "123.45",
"externalAmount": "123.45",
"pointsAmount": "123.45"
}
RenderedCart
Примечание
Стоимость доставки передавайте в items как отдельный товар.
Важно
В соответствии с Федеральным законом № 283‑ФЗ «О деятельности по предоставлению сервиса рассрочки» при использовании сервиса Сплит договор о предоставлении сервиса рассрочки с пользователем обязательно должен содержать сведения об объекте рассрочки — товарах, работах, услугах или результатах интеллектуальной деятельности, оплачиваемых в Сплит.
Поэтому в запросе обязательно передавайте данные всех объектов рассрочки в корзине в параметре cart.items.
|
Name |
Description |
|
items |
Type: RenderedCartItem[] Корзина товаров, которую оплачивает покупатель. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example
|
|
total |
All of 1 type
Итоговая информация о стоимости заказа. Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй. Example
|
|
externalId |
Type: string Идентификатор корзины на стороне продавца. Max length: Example: |
Example
{
"externalId": "example",
"items": [
{
"description": "example",
"discountedUnitPrice": "123.45",
"features": {
"pointsDisabled": false,
"tariffModifier": "VERY_LOW"
},
"pointsAmount": "123.45",
"productId": "example",
"quantity": {
"available": "123.45",
"count": "123.45"
},
"receipt": {
"agent": {},
"excise": "123.45",
"markQuantity": {},
"measure": 0,
"paymentMethodType": 1,
"paymentSubjectType": 1,
"productCode": "example",
"supplier": {},
"tax": 1,
"title": "example"
},
"skuId": "example",
"subtotal": "123.45",
"title": "example",
"total": "123.45",
"unitPrice": "123.45"
}
],
"total": {
"amount": "123.45",
"externalAmount": "123.45",
"pointsAmount": "123.45"
}
}
CreateQuickpayCpqrOrderResponseData
|
Name |
Description |
|
quickpayPaymentStatus |
Type: string Enum: Max length: |
Example
{
"quickpayPaymentStatus": "started"
}