/v1/orders

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

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

Request

POST

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

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

Production

Sandbox

Body

application/json

{
    "availablePaymentMethods": null,
    "cart": {
        "externalId": "string",
        "items": [
            {
                "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"
        }
    },
    "orderId": "string",
    "purpose": "string",
    "redirectUrls": {
        "onError": "string",
        "onSuccess": "string"
    },
    "ttl": 1800
}

Name	Type	Description
availablePaymentMethods	string[]	Доступные методы оплаты на платежной форме Яндекс Пэй. Если вы интегрируете оплату только одним методом, например, Сплит — указывается один метод `["SPLIT"]`. Для платежей по банковским картам и через Сплит необходимо передать: `["CARD", "SPLIT"]`. Enum: `CARD`, `SPLIT`
cart*	RenderedCart	Корзина
currencyCode*	string	Трехбуквенный код валюты заказа (ISO 4217) Enum: `RUB`
extensions	OrderExtensions	Дополнительные параметры для оформления оффлайн заказа
orderId*	string	Идентификатор заказа на стороне продавца (должен быть уникальным). Дальнейшее взаимодействие по заявке на оплату будет осуществляться с использованием этого идентификатора. Также данный идентификатор будет использоваться в сверках
purpose	string	Назначение платежа
redirectUrls	MerchantRedirectUrls	Ссылки для переадресации пользователя с формы оплаты. Обязательно для онлайн продавца
ttl	integer<int32>	Время жизни заказа (в секундах) `180 <= ttl <= 604800` Default: `1800`

RenderedCart

Корзина

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

OrderExtensions

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

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

MerchantRedirectUrls

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

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

RenderedCartItem

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

CartTotal

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

BillingReport

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

Name	Type	Description
branchId	string	Идентификатор точки продаж
managerId	string	Идентификатор менеджера

QRData

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

Name	Type	Description
token*	string	QR токен

SMSOffer

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

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

ItemQuantity

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

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

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

Agent

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

MarkQuantity

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

Supplier

Name	Type	Description
inn	string
name	string
phones	string[]

PaymentsOperator

Name	Type	Description
phones	string[]

TransferOperator

Name	Type	Description
address	string
inn	string
name	string
phones	string[]

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	Ссылка на оплату заказа

/v1/orders

RequestRequest

BodyBody

RenderedCartRenderedCart

OrderExtensionsOrderExtensions

MerchantRedirectUrlsMerchantRedirectUrls

RenderedCartItemRenderedCartItem

CartTotalCartTotal

BillingReportBillingReport

QRDataQRData

SMSOfferSMSOffer

ItemQuantityItemQuantity

ItemReceiptItemReceipt

AgentAgent

MarkQuantityMarkQuantity

SupplierSupplier

PaymentsOperatorPaymentsOperator

TransferOperatorTransferOperator

ResponsesResponses

200 OK200 OK

BodyBody

CreateOrderResponseDataCreateOrderResponseData

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

Request

Body

RenderedCart

OrderExtensions

MerchantRedirectUrls

RenderedCartItem

CartTotal

BillingReport

QRData

SMSOffer

ItemQuantity

ItemReceipt

Agent

MarkQuantity

Supplier

PaymentsOperator

TransferOperator

Responses

200 OK

Body

CreateOrderResponseData