/v1/orders

Запрос на создание ссылки на оплату заказа.

Запрос используется для создания и получения ссылки на оплату заказа.

Request

POST

https://pay.yandex.ru/api/merchant/v1/orders

Production

POST

https://sandbox.pay.yandex.ru/api/merchant/v1/orders

Sandbox

Body

application/json

{
    "availablePaymentMethods": null,
    "cart": {
        "externalId": "string",
        "items": [
            {
                "description": "string",
                "discountedUnitPrice": "123.45",
                "productId": "string",
                "quantity": {
                    "available": "123.45",
                    "count": "123.45",
                    "label": "string"
                },
                "receipt": {
                    "agent": {
                        "agentType": 1,
                        "operation": "string",
                        "paymentsOperator": {
                            "phones": [
                                "string"
                            ]
                        },
                        "phones": [
                            "string"
                        ],
                        "transferOperator": {
                            "address": "string",
                            "inn": "string",
                            "name": "string",
                            "phones": [
                                "string"
                            ]
                        }
                    },
                    "excise": "123.45",
                    "markQuantity": {
                        "denominator": 0,
                        "numerator": 0
                    },
                    "measure": 0,
                    "paymentMethodType": 1,
                    "paymentSubjectType": 1,
                    "productCode": "string",
                    "supplier": {
                        "inn": "string",
                        "name": "string",
                        "phones": [
                            "string"
                        ]
                    },
                    "tax": 1,
                    "title": "string"
                },
                "subtotal": "123.45",
                "title": "string",
                "total": "123.45",
                "unitPrice": "123.45"
            }
        ],
        "total": {
            "amount": "123.45",
            "label": "string"
        }
    },
    "currencyCode": "RUB",
    "extensions": {
        "billingReport": {
            "branchId": null,
            "managerId": null
        },
        "qrData": {
            "token": "string"
        },
        "smsOffer": {
            "phone": "string"
        }
    },
    "metadata": "string",
    "orderId": "string",
    "orderSource": "WEBSITE",
    "preferredPaymentMethod": "FULLPAYMENT",
    "purpose": "string",
    "redirectUrls": {
        "onAbort": "string",
        "onError": "string",
        "onSuccess": "string"
    },
    "risk": {
        "billingPhone": "string",
        "deviceId": "string",
        "shippingAddress": "string",
        "shippingPhone": "string",
        "shippingType": "COURIER"
    },
    "ttl": 1800
}

Name	Type	Description
availablePaymentMethods	string[]	Доступные методы оплаты на платежной форме Яндекс Пэй. Если вы интегрируете оплату только одним методом, например, Карта — указывается один метод `["CARD"]`. Для платежей по банковским картам и через Сплит необходимо передать: `["CARD", "SPLIT"]`. Enum: `CARD`, `SPLIT`
cart*	RenderedCart	Корзина
currencyCode*	string	Трехбуквенный код валюты заказа (ISO 4217) Enum: `RUB` Max length: `2048`
extensions	OrderExtensions	Дополнительные параметры для оформления офлайн заказа
metadata	string	Произвольные данные по заказу для внутреннего использования Max length: `2048`
orderId*	string	Идентификатор заказа на стороне продавца (должен быть уникальным). Дальнейшее взаимодействие по заявке на оплату будет осуществляться с использованием этого идентификатора. Также данный идентификатор будет использоваться в сверках Max length: `2048`
orderSource	string	Поверхность на которой инициализировали создание заказа Необходимо для последующей аналитики WEBSITE: Кнопка размещена на сайте. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя на сайте APP: Кнопка размещена в мобильном приложении. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя в приложении CRM: Ссылка на оплату сформирована менеджером в CRM или другой админке CASH_REGISTER: Ссылка на оплату сформирована для отображения на офлайн-кассе Enum: `WEBSITE`, `APP`, `CRM`, `CASH_REGISTER` Default: `null`
preferredPaymentMethod	string	Предпочтительный метод оплаты. Переданный метод будет автоматически выбран на форме оплаты, если это не противоречит доступным методам оплаты. По умолчанию - Карта. Enum: `FULLPAYMENT`, `SPLIT`
purpose	string	Назначение платежа Max length: `128`
redirectUrls	MerchantRedirectUrls	Ссылки для переадресации пользователя с формы оплаты. Обязательно для онлайн продавца
risk	RiskInfo	Дополнительная информация, наличие которой может увеличить вероятность одобрения по Сплиту. Доступно в полной мере только для онлайн-магазинов.
ttl	integer<int32>	Параметр определяет время, в течение которого пользователь может воспользоваться ссылкой на форму оплаты заказа. По истечении времени пользователь будет видеть сообщение "Истёк срок оплаты по ссылке". Если пользователь воспользовался ссылкой до истечения времени, то на завершение оплаты отводится дополнительно 15 минут. Если по истечении дополнительного времени оплата не произошла, заказ считается не оплаченным окончательно. Это отражается в изменении статуса заказа `Order.paymentStatus` на значение `FAILED`. Также выполняется отправка уведомления об изменении статуса заказа. Если продавец бронировал товар, то после изменения статуса заказ можно отменить. Время жизни (сек): `180 <= ttl <= 604800` Время жизни (при создании ссылки в личном кабинете, сек): `86400` Default: `1800`

RenderedCart

Корзина

Name	Type	Description
externalId	string	Переданный продавцом идентификатор корзины Max length: `2048`
items*	RenderedCartItem[]
total*	CartTotal

OrderExtensions

Дополнительные параметры для оформления офлайн заказа

Name	Type	Description
billingReport	BillingReport	Дополнительные параметры для отчета сплита
qrData	QRData	Дополнительные параметры для отправки ссылки на оплату с использованием QR
smsOffer	SMSOffer	Дополнительные параметры для отправки ссылки на оплату с использованием SMS

MerchantRedirectUrls

Ссылки для переадресации пользователя с формы оплаты. Обязательно для онлайн продавца

Name	Type	Description
onAbort	string	Ссылка для переадресации пользователя в случае отмены процесса оплаты Max length: `2048`
onError*	string	Ссылка для переадресации пользователя в случае возникновения ошибки во время оплаты, или если срок ссылки на оплату истек Max length: `2048`
onSuccess*	string	Ссылка для переадресации пользователя в случае успешной оплаты Max length: `2048`

RiskInfo

Дополнительная информация, наличие которой может увеличить вероятность одобрения по Сплиту. Доступно в полной мере только для онлайн-магазинов.

Name	Type	Description
billingPhone	string	Номер телефона клиента (пример +71234567890) Max length: `2048`
deviceId	string	Идентификатор устройства клиента (device_id/gaid/idfa/ifv) Max length: `2048`
shippingAddress	string	Адрес доставки Max length: `2048`
shippingPhone	string	Номер телефона получателя (пример +71234567890) Max length: `2048`
shippingType	string	Способ получения заказа Enum: `COURIER`, `PICKUP`

RenderedCartItem

Name	Type	Description
description	string	Описание товара Max length: `2048`
discountedUnitPrice	string<double>	Цена за единицу товара с учётом скидок на позицию Example: `123.45`
productId*	string	Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным Max length: `2048`
quantity*	ItemQuantity	Количество товара в заказе
receipt	ItemReceipt	Данные для формирования чека
subtotal	string<double>	Суммарная цена за позицию без учета скидок Example: `123.45`
title*	string	Наименование товара Max length: `2048`
total*	string<double>	Суммарная цена за позицию с учётом скидок на позицию Example: `123.45`
unitPrice	string<double>	Полная цена за единицу товара без учетка скидки Example: `123.45`

CartTotal

Name	Type	Description
amount*	string<double>	Стоимость корзины с учетом всех скидок, и без учета доставки Example: `123.45`
label	string	Max length: `2048`

BillingReport

Дополнительные параметры для отчета сплита

Name	Type	Description
branchId	string	Идентификатор точки продаж Default: `null` Max length: `2048`
managerId	string	Идентификатор менеджера Default: `null` Max length: `2048`

QRData

Дополнительные параметры для отправки ссылки на оплату с использованием QR

Name	Type	Description
token*	string	QR токен Max length: `2048`

SMSOffer

Дополнительные параметры для отправки ссылки на оплату с использованием SMS

Name	Type	Description
phone*	string	Номер телефона клиента (пример +71234567890) Max length: `2048`

ItemQuantity

Количество товара в заказе

Name	Type	Description
available	string<double>	Максимально доступное количество товара Example: `123.45`
count*	string<double>	Количество товара в заказе Example: `123.45`
label	string	Название единиц измерения, например "кг" или "шт" Max length: `2048`

ItemReceipt

Данные для формирования чека

Name	Type	Description
agent	Agent
excise	string<double>	Не должно содержать больше двух знаков после запятой. Например: 1.12, 5.1, 10, 11.00 . Example: `123.45`
markQuantity	MarkQuantity
measure	integer	Описание значений: Ссылка Enum: `0`, `10`, `11`, `12`, `20`, `21`, `22`, `30`, `31`, `32`, `40`, `41`, `42`, `50`, `51`, `70`, `71`, `72`, `73`, `80`, `81`, `82`, `83`, `255`, `null`
paymentMethodType	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `null`
paymentSubjectType	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `null`
productCode	string<base64>	Код товара (base64 кодированный массив от 1 до 32 байт)
supplier	Supplier
tax*	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`
title	string	Max length: `2048`

Agent

Name	Type	Description
agentType*	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	string	Max length: `2048`
paymentsOperator	PaymentsOperator
phones	string[]	Max length: `2048`
transferOperator	TransferOperator

MarkQuantity

Name	Type	Description
denominator*	integer<int32>
numerator*	integer<int32>

Supplier

Name	Type	Description
inn	string	Max length: `2048`
name	string	Max length: `2048`
phones	string[]	Max length: `2048`

PaymentsOperator

Name	Type	Description
phones	string[]	Max length: `2048`

TransferOperator

Name	Type	Description
address	string	Max length: `2048`
inn	string	Max length: `2048`
name	string	Max length: `2048`
phones	string[]	Max length: `2048`

Responses

200 OK

Body

application/json

{
    "code": 200,
    "data": {
        "paymentUrl": "string"
    },
    "status": "success"
}

Name	Type	Description
code	number	Default: `200`
data*	CreateOrderResponseData
status	string	Enum: `success` Default: `success`

CreateOrderResponseData

Name	Type	Description
paymentUrl*	string	Ссылка на оплату заказа Max length: `2048`

/v1/orders

RequestRequest

BodyBody

RenderedCartRenderedCart

OrderExtensionsOrderExtensions

MerchantRedirectUrlsMerchantRedirectUrls

RiskInfoRiskInfo

RenderedCartItemRenderedCartItem

CartTotalCartTotal

BillingReportBillingReport

QRDataQRData

SMSOfferSMSOffer

ItemQuantityItemQuantity

ItemReceiptItemReceipt

AgentAgent

MarkQuantityMarkQuantity

SupplierSupplier

PaymentsOperatorPaymentsOperator

TransferOperatorTransferOperator

ResponsesResponses

200 OK200 OK

BodyBody

CreateOrderResponseDataCreateOrderResponseData

Была ли статья полезна?

Request

Body

RenderedCart

OrderExtensions

MerchantRedirectUrls

RiskInfo

RenderedCartItem

CartTotal

BillingReport

QRData

SMSOffer

ItemQuantity

ItemReceipt

Agent

MarkQuantity

Supplier

PaymentsOperator

TransferOperator

Responses

200 OK

Body

CreateOrderResponseData