/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,
    "billingPhone": "string",
    "cart": {
        "externalId": "string",
        "items": [
            {
                "description": "string",
                "discountedUnitPrice": "123.45",
                "features": {
                    "pointsDisabled": false,
                    "tariffModifier": "VERY_LOW"
                },
                "productId": "string",
                "quantity": {
                    "available": "123.45",
                    "count": "123.45"
                },
                "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"
                },
                "skuId": "string",
                "subtotal": "123.45",
                "title": "string",
                "total": "123.45",
                "unitPrice": "123.45"
            }
        ],
        "total": {
            "amount": "123.45"
        }
    },
    "currencyCode": "RUB",
    "extensions": {
        "billingReport": {
            "branchId": null,
            "managerId": null
        },
        "paymentData": {
            "saleToken": "string"
        },
        "qrData": {
            "token": "string"
        },
        "smsOffer": {
            "phone": "string"
        }
    },
    "isPrepayment": false,
    "metadata": "string",
    "orderId": "string",
    "orderSource": "WEBSITE",
    "preferredPaymentMethod": "FULLPAYMENT",
    "publicConstructor": "string",
    "purpose": "string",
    "redirectUrls": {
        "onAbort": "string",
        "onError": "string",
        "onSuccess": "string"
    },
    "risk": {
        "billingPhone": "string",
        "customerAggregates": {
            "amountFirstSuccessfulOrder": "123.45",
            "amountLatestSuccessfulOrder": "123.45",
            "cookie": "string",
            "daysSinceLastPasswordReset": 0,
            "failedLoginAttemptsOneDay": 0,
            "failedLoginAttemptsSevenDays": 0,
            "firstSuccessfulOrderDate": "2025-01-15",
            "historicalCookieLogin": false,
            "historicalDeviceLogin": false,
            "lastPasswordResetDate": "2025-01-15",
            "latestSuccessfulOrderLastYearDate": "2025-01-15",
            "previousSuccessfulOrdersAtSameAddress": false,
            "redemptionRateLastHalfYear": "123.45",
            "registrationDate": "2025-01-15"
        },
        "deviceId": "string",
        "isExpressShipping": false,
        "merchantMcc": "string",
        "merchantName": "string",
        "merchantOfflinePosLegalAddress": "string",
        "merchantTaxRefNumber": "string",
        "periodCheckAggregates": {
            "successfulOrdersCountNineMonths": 0,
            "successfulOrdersCountOneMonth": 0,
            "successfulOrdersCountSixMonths": 0,
            "successfulOrdersCountThreeMonths": 0,
            "successfulOrdersCountTwelveMonths": 0,
            "totalAmountSuccessfulOrdersNineMonths": "123.45",
            "totalAmountSuccessfulOrdersOneMonth": "123.45",
            "totalAmountSuccessfulOrdersSixMonths": "123.45",
            "totalAmountSuccessfulOrdersThreeMonths": "123.45",
            "totalAmountSuccessfulOrdersTwelveMonths": "123.45"
        },
        "qrType": "static",
        "qrcId": "string",
        "shippingAddress": "string",
        "shippingPhone": 71234567890,
        "shippingType": "COURIER"
    },
    "ttl": 1800
}

Name

Description

cart*

Type: RenderedCart

Корзина

currencyCode*

Type: string

Трехбуквенный код валюты заказа (ISO 4217)

Max length: 2048

Enum: RUB, UZS

orderId*

Type: string

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

Используется:

  • как ключ идемпотентности;
  • для дальнейшего взаимодействия по заказу и платежу;
  • в сверках.

Max length: 2048

availablePaymentMethods

Type: string[]

Доступные методы оплаты на платежной форме Яндекс Пэй.

Если вы интегрируете оплату только одним методом, например, Карта — указывается один метод ["CARD"]. Для платежей по банковским картам и через Сплит необходимо передать: ["CARD", "SPLIT"].

Enum: CARD, SPLIT

Default: null

Min items: 1

billingPhone

Type: string

Номер телефона клиента.

Используется для упрощения авторизации, а также может увеличить вероятность одобрения по Сплиту.

Для номера телефона предлагаем использовать формат +71234567890 или 71234567890. В строке допустимо наличие других символов, однако все символы, кроме цифр, игнорируются. Если номер телефона начинается с 8, то он обрабатывается как аналогичный номер, где 8 заменена на +7.

Например, такие переданные значения 71234567890, +71234567890, 81234567890, +7 (123) 456-78-90 будут обрабатываться как 71234567890.

Max length: 2048

extensions

Type: OrderExtensions

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

isPrepayment

Type: boolean

Проводить ли заказ по флоу «отложенной оплаты».

Если параметр установлен в true, то заказ будет оформляться как заказ с отложенной оплатой.

metadata

Type: string

Произвольные данные по заказу для внутреннего использования

Max length: 2048

orderSource

Type: string

Поверхность на которой инициализировали создание заказа

Необходимо для последующей аналитики

WEBSITE: Кнопка размещена на сайте. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя на сайте

APP: Кнопка размещена в мобильном приложении. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя в приложении

CRM: Ссылка на оплату сформирована менеджером в CRM или другой админке

CASH_REGISTER: Ссылка на оплату сформирована для отображения на оффлайн-кассе

CMS_PLUGIN: Ссылка на оплату сформирована в плагине для CMS

TV: Ссылка на оплату сформирована для отображения на ТВ-платформе

Default: null

Enum: WEBSITE, APP, CRM, CASH_REGISTER, CMS_PLUGIN, TV

preferredPaymentMethod

Type: string

Предпочтительный метод оплаты.

Переданный метод будет автоматически выбран на форме оплаты, если это не противоречит доступным методам оплаты.

Default: FULLPAYMENT

Enum: FULLPAYMENT, SPLIT

publicConstructor

Type: string

Конструктор предвыбранного плана для оплаты в Сплит.

Доступно только по согласованию

purpose

Type: string

Назначение платежа

Max length: 1000

redirectUrls

Type: MerchantRedirectUrls

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

risk

Type: MerchantRiskInfo

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

ttl

Type: integer<int32>

Параметр определяет время, в течение которого пользователь может воспользоваться ссылкой на форму оплаты заказа.

По истечении времени пользователь будет видеть сообщение "Вышло время оплаты".

Если пользователь воспользовался ссылкой до истечения времени, то на завершение оплаты отводится дополнительно 15 минут. Если по истечении дополнительного времени оплата не произошла, заказ считается не оплаченным окончательно.

Это отражается в изменении статуса заказа Order.paymentStatus на значение FAILED. Также выполняется отправка уведомления об изменении статуса заказа. Если продавец бронировал товар, то после изменения статуса заказ можно отменить.

Время жизни (сек): 180 <= ttl <= 604800

Время жизни (при создании ссылки в личном кабинете, сек): 86400

Default: 1800

RenderedCart

Примечание

Стоимость доставки передавайте в items как отдельный товар.

Name

Description

items*

Type: RenderedCartItem[]

Корзина товаров, которую оплачивает покупатель.

total*

Type: CartTotal

Итоговая информация о стоимости заказа.

externalId

Type: string

Идентификатор корзины на стороне продавца.

Max length: 2048

OrderExtensions

Name

Description

billingReport

Type: BillingReport

Информация о месте и авторе оформления заказа.

paymentData

Type: PaymentData

Дополнительные параметры платежа

qrData

Type: QRData

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

smsOffer

Type: SMSOffer

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

Обязательное поле только для офлайн-магазинов.

MerchantRedirectUrls

Примечание

В мобильных интеграциях, использующих App Link и Universal Link, в поле redirectUrls можно указать базовый URL сайта.

Name

Description

onError*

Type: string

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

Max length: 2048

onSuccess*

Type: string

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

Max length: 2048

onAbort

Type: string

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

Max length: 2048

MerchantRiskInfo

Name

Description

billingPhone

Type: string

DEPRECATED Номер телефона клиента.
Cледует использовать одноименное поле на уровень выше.

Max length: 2048

customerAggregates

Type: CustomerAggregates

Агрегированные данные о клиенте

deviceId

Type: string

Идентификатор устройства клиента (device_id/gaid/idfa/ifv)

Max length: 2048

isExpressShipping

Type: boolean

Признак экспресс-доставки

merchantMcc

Type: string

MCC мерчанта

Max length: 2048

merchantName

Type: string

Название мерчанта

Max length: 2048

merchantOfflinePosLegalAddress

Type: string

Юридический адрес оффлайн точки

Max length: 2048

merchantTaxRefNumber

Type: string

Налоговый номер мерчанта

Max length: 2048

periodCheckAggregates

Type: PeriodCheckAggregates

Агрегаты по чекам за различные периоды

qrType

Type: string

Тип QR-кода

Enum: static, dynamic, null

qrcId

Type: string

ID QR-кода

Max length: 2048

shippingAddress

Type: string

Адрес доставки. Если выбран способ получения «самовывоз» (PICKUP), то нужно указать адрес пункта выдачи.

Max length: 2048

shippingPhone

Type: string

Номер телефона получателя.

Example: 71234567890

Max length: 2048

shippingType

Type: string

Способ получения заказа

Enum: COURIER, PICKUP, null

RenderedCartItem

Name

Description

productId*

Type: string

Id товара в системе продавца. В параметрах запроса каждый идентификатор товара productId должен быть уникальным

Max length: 2048

quantity*

Type: ItemQuantity

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

title*

Type: string

Наименование товара

Max length: 2048

total*

Type: string<double>

Итоговая цена позиции с учетом примененных скидок.

Важно

Убедитесь, что цена за единицу товара (total / quantity.count) имеет максимум 2 знака в дробной части. Иначе вернется ошибка ORDER_CART_DATA_ERROR.

Чтобы избежать ошибок, вынесите товары в отдельные позиции с разными productId.

Пример

Правильно:

{
  "productId": "xxx-123",
  "quantity": {
    "count": "2"
  },
  "title": "Мармелад",
  "total": "100.50"
}

Цена за единицу 100.50 / 2 = 50.25 c двумя знаками в дробной части.

Неправильно:

{
  "productId": "xxx-123",
  "quantity": {
    "count": "2"
  },
  "title": "Мармелад",
  "total": "100.25"
}

Цена за единицу 100.25 / 2 = 50.125 c тремя знаками в дробной части.

В таком случае разбейте на две позиции:

[
  {
    "productId": "xxx-123-1",
    "quantity": {
      "count": "1"
    },
    "title": "Мармелад",
    "total": "50.25"
  },
  {
    "productId": "xxx-123-2",
    "quantity": {
      "count": "1"
    },
    "title": "Мармелад со скидкой",
    "total": "50"
  }
]

Example: 123.45

description

Type: string

Описание товара

Max length: 2048

discountedUnitPrice

Type: string<double>

Цена за единицу товара с учётом скидок на позицию

Example: 123.45

features

Type: CartItemFeatures

Промо параметры товара

receipt

⦸

Type: ItemReceipt

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

Deprecated

В актуальных интеграциях передавать данные для чека не требуется. Чек формируется на вашей стороне. Подробнее см. в разделе Фискализация.

skuId

Type: string

Уникальный id, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа.

Max length: 2048

subtotal

Type: string<double>

Суммарная цена за позицию без учета скидок

Example: 123.45

unitPrice

Type: string<double>

Полная цена за единицу товара без учетка скидки

Example: 123.45

CartTotal

Name

Description

amount*

Type: string<double>

Стоимость корзины с учетом всех скидок.

Example: 123.45

BillingReport

Name

Description

branchId

Type: string

Обязательное поле только для офлайн-магазинов. Идентификатор точки продаж

Default: null

Max length: 2048

managerId

Type: string

Обязательное поле только для офлайн-магазинов. Идентификатор менеджера

Default: null

Max length: 2048

PaymentData

Name

Description

saleToken

Type: string

Уникальный id, генерируемый кассой для каждой операции оплаты

Max length: 2048

QRData

Name

Description

token*

Type: string

QR токен

Max length: 2048

SMSOffer

Name

Description

phone*

Type: string

Номер телефона клиента (пример +71234567890) для СМС-информирования. Только для merchantId офлайн-магазина.

Max length: 2048

Pattern: ^\+\d+$

CustomerAggregates

Name

Description

amountFirstSuccessfulOrder

Type: string<double>

Сумма первого успешного заказа

Example: 123.45

amountLatestSuccessfulOrder

Type: string<double>

Сумма последнего успешного заказа

Example: 123.45

cookie

Type: string

Куки

Max length: 2048

daysSinceLastPasswordReset

Type: integer<int32>

Количество дней с момента последнего сброса пароля

failedLoginAttemptsOneDay

Type: integer<int32>

Количество неуспешных попыток входа за последний день

failedLoginAttemptsSevenDays

Type: integer<int32>

Количество неуспешных попыток входа за последние 7 дней

firstSuccessfulOrderDate

Type: string<date>

Дата первого успешного заказа в истории

Example: 2025-01-15

historicalCookieLogin

Type: boolean

Вход с сохраненной куки (ранее уже оплачивал заказ)

historicalDeviceLogin

Type: boolean

Вход с сохраненного устройства (ранее уже оплачивал заказ)

lastPasswordResetDate

Type: string<date>

Дата последнего сброса пароля

Example: 2025-01-15

latestSuccessfulOrderLastYearDate

Type: string<date>

Дата последнего успешного заказа за последний год

Example: 2025-01-15

previousSuccessfulOrdersAtSameAddress

Type: boolean

Был ли у пользователя успешный заказ по текущему адресу ранее

redemptionRateLastHalfYear

Type: string<double>

Процент выкупа за последние полгода

Example: 123.45

registrationDate

Type: string<date>

Дата регистрации на сайте мерчанта

Example: 2025-01-15

PeriodCheckAggregates

Name

Description

successfulOrdersCountNineMonths

Type: integer<int32>

Количество успешных заказов за последние 9 месяцев

successfulOrdersCountOneMonth

Type: integer<int32>

Количество успешных заказов за последний месяц

successfulOrdersCountSixMonths

Type: integer<int32>

Количество успешных заказов за последние 6 месяцев

successfulOrdersCountThreeMonths

Type: integer<int32>

Количество успешных заказов за последние 3 месяца

successfulOrdersCountTwelveMonths

Type: integer<int32>

Количество успешных заказов за последние 12 месяцев

totalAmountSuccessfulOrdersNineMonths

Type: string<double>

Сумма успешных заказов за последние 9 месяцев

Example: 123.45

totalAmountSuccessfulOrdersOneMonth

Type: string<double>

Сумма успешных заказов за последний месяц

Example: 123.45

totalAmountSuccessfulOrdersSixMonths

Type: string<double>

Сумма успешных заказов за последние 6 месяцев

Example: 123.45

totalAmountSuccessfulOrdersThreeMonths

Type: string<double>

Сумма успешных заказов за последние 3 месяца

Example: 123.45

totalAmountSuccessfulOrdersTwelveMonths

Type: string<double>

Сумма успешных заказов за последние 12 месяцев

Example: 123.45

ItemQuantity

Name

Description

count*

Type: string<double>

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

Example: 123.45

available

Type: string<double>

Максимально доступное количество товара

Example: 123.45

CartItemFeatures

Name

Description

pointsDisabled

Type: boolean

Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар

Default: false

tariffModifier

Type: string

Модификатор тарифа для расчета комиссии. Определяет, какой тариф будет применяться при расчете комиссии за обработку позиции в корзине.

Enum: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH, null

ItemReceipt

Deprecated

В актуальных интеграциях передавать данные для чека не требуется. Чек формируется на вашей стороне. Подробнее см. в разделе Фискализация.

Name

Description

tax*

Type: integer

Описание значений: Ссылка

Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

agent

⦸

Type: Agent

excise

Type: string<double>

Не должно содержать больше двух знаков после запятой. Например: 1.12, 5.1, 10, 11.00 .

Example: 123.45

markQuantity

⦸

Type: MarkQuantity

measure

Type: 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

Type: integer

Описание значений: Ссылка

Enum: 1, 2, 3, 4, 5, 6, 7, null

paymentSubjectType

Type: 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

Type: string<base64>

Код товара (base64 кодированный массив от 1 до 32 байт)

supplier

⦸

Type: Supplier

title

Type: string

Max length: 2048

Agent

Name

Description

agentType*

Type: integer

Признак агента по предмету расчёта. См. значения

Enum: 1, 2, 3, 4, 5, 6, 7

operation

Type: string

Max length: 2048

paymentsOperator

⦸

Type: PaymentsOperator

phones

Type: string[]

Max length: 2048

transferOperator

⦸

Type: TransferOperator

MarkQuantity

Name

Description

denominator*

Type: integer<int32>

numerator*

Type: integer<int32>

Supplier

Name

Description

inn

Type: string

Max length: 2048

name

Type: string

Max length: 2048

phones

Type: string[]

Max length: 2048

PaymentsOperator

Name

Description

phones

Type: string[]

Max length: 2048

TransferOperator

Name

Description

address

Type: string

Max length: 2048

inn

Type: string

Max length: 2048

name

Type: string

Max length: 2048

phones

Type: string[]

Max length: 2048

Responses

200 OK

Body

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

Name

Description

data*

Type: CreateOrderResponseData

code

Type: number

Default: 200

status

Type: string

Default: success

Enum: success

CreateOrderResponseData

Name

Description

paymentUrl*

Type: string

Ссылка на оплату заказа

Max length: 2048

No longer supported, please use an alternative and newer version.

Предыдущая
Overview
Следующая
/v1/orders/{order_id}