/v1/ordersㅤ

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

Фискализация

Если вы используете облачную кассу АТОЛ Онлайн или CloudKassir и у вас в личном кабинете подключена фискализация через Яндекс Пэй, обязательно передавайте следующие поля. Без них чек не сформируется.

Таблица полей для фискализации
Поле Описание
orderId Уникальный идентификатор заказа на стороне продавца.
currencyCode Трехбуквенный код валюты заказа (ISO 4217).
availablePaymentMethods Доступные методы оплаты на платежной форме Яндекс Пэй.
fiscalContact Контактные данные покупателя (почта или номер телефона) для отправки электронного фискального чека.
cart Корзина.
cart.items Список позиций в корзине.
cart.items[].productId Уникальный идентификатор товара в системе продавца.
cart.items[].title Наименование товара.
cart.items[].quantity.count Количество товара в заказе.
cart.items[].total Итоговая цена позиции с учетом примененных скидок.
cart.items[].receipt.tax Ставка НДС. Описание значений см. по ссылке.
cart.total.amount Стоимость корзины с учетом всех скидок.
Пример Body для фискализации
{
  "orderId": "order-100",
  "currencyCode": "RUB",
  "availablePaymentMethods": ["CARD", "SPLIT"],
  "fiscalContact": "user@example.com",
  "cart": {
    "items": [
      {
        "productId": "item-1",
        "title": "Название товара",
        "quantity": {
          "count": "1"
        },
        "total": "100.00",
        "receipt": {
          "tax": 1
        }
      }
    ],
    "total": {
      "amount": "100.00"
    }
  }
}

Ограничение

  • Фискализация работает, только если вы используете базовую механику приема оплаты.

  • При продаже маркированных товаров чеки не формируются из-за ограничений сервиса Яндекс Пэй, данные не передаются в систему маркировки Честный знак.

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": "example",
  "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",
  "extensions": null,
  "isPrepayment": true,
  "metadata": "example",
  "orderId": "example",
  "orderSource": "null",
  "preferredPaymentMethod": "FULLPAYMENT",
  "publicConstructor": "example",
  "purpose": "example",
  "redirectUrls": {
    "onAbort": "example",
    "onError": "example",
    "onSuccess": "example"
  },
  "risk": {
    "billingPhone": "example",
    "customerAggregates": {
      "amountFirstSuccessfulOrder": "123.45",
      "amountLatestSuccessfulOrder": "123.45",
      "cookie": "example",
      "daysSinceLastPasswordReset": 0,
      "failedLoginAttemptsOneDay": 0,
      "failedLoginAttemptsSevenDays": 0,
      "firstSuccessfulOrderDate": "2025-01-15",
      "historicalCookieLogin": true,
      "historicalDeviceLogin": true,
      "lastPasswordResetDate": "2025-01-15",
      "latestSuccessfulOrderLastYearDate": "2025-01-15",
      "previousSuccessfulOrdersAtSameAddress": true,
      "redemptionRateLastHalfYear": "123.45",
      "registrationDate": "2025-01-15"
    },
    "deviceId": "example",
    "isExpressShipping": true,
    "merchantMcc": "example",
    "merchantName": "example",
    "merchantOfflinePosLegalAddress": "example",
    "merchantTaxRefNumber": "example",
    "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": "example",
    "shippingAddress": "example",
    "shippingPhone": "71234567890",
    "shippingType": "COURIER"
  },
  "ttl": 1800,
  "fiscalContact": "test@example.com"
}

Name

Description

cart

All of 1 type
  • Type: RenderedCart

    Примечание

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

    Важно

    В соответствии с Федеральным законом № 283‑ФЗ «О деятельности по предоставлению сервиса рассрочки» при использовании сервиса Сплит договор о предоставлении сервиса рассрочки с пользователем обязательно должен содержать сведения об объекте рассрочки — товарах, работах, услугах или результатах интеллектуальной деятельности, оплачиваемых в Сплит.

    Поэтому в запросе обязательно передавайте данные всех объектов рассрочки в корзине в параметре cart.items.

    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"
      }
    }
    

Корзина.

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Example
{
  "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

Type: string

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Enum: RUB, UZS

Max length: 2048

orderId

Type: string

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

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

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Max length: 2048

Example: example

availablePaymentMethods

Type: string[]

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

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Default: null

Min items: 1

Example
[
  "CARD"
]

billingPhone

Type: string

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

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

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

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

Max length: 2048

Example: example

extensions

All of 1 type
  • Type: OrderExtensions

    Example
    {
      "billingReport": {
        "branchId": "null",
        "managerId": "null"
      },
      "paymentData": {
        "saleToken": "example"
      },
      "qrData": {
        "token": "example"
      },
      "smsOffer": {
        "phone": "example"
      }
    }
    

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

Default: null

fiscalContact

Type: string

Контактные данные покупателя (почта или номер телефона) для отправки электронного фискального чека.

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Рекомендуемые форматы для телефона: +71234567890 или 71234567890.

Все символы, кроме цифр, игнорируются. Номера, начинающиеся с 8 обрабатываются как +7.

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

Example: test@example.com

isPrepayment

Type: boolean

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

Используется в механике Сплит c оплатой «при получении».

metadata

Type: string

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

Max length: 2048

Example: example

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

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

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

Example: example

purpose

Type: string

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

Max length: 1000

Example: example

redirectUrls

All of 1 type
  • Type: MerchantRedirectUrls

    Примечание

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

    Example
    {
      "onAbort": "example",
      "onError": "example",
      "onSuccess": "example"
    }
    

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

Example
{
  "onAbort": "example",
  "onError": "example",
  "onSuccess": "example"
}

risk

All of 1 type
  • Type: MerchantRiskInfo

    Example
    {
      "billingPhone": "example",
      "customerAggregates": {
        "amountFirstSuccessfulOrder": "123.45",
        "amountLatestSuccessfulOrder": "123.45",
        "cookie": "example",
        "daysSinceLastPasswordReset": 0,
        "failedLoginAttemptsOneDay": 0,
        "failedLoginAttemptsSevenDays": 0,
        "firstSuccessfulOrderDate": "2025-01-15",
        "historicalCookieLogin": true,
        "historicalDeviceLogin": true,
        "lastPasswordResetDate": "2025-01-15",
        "latestSuccessfulOrderLastYearDate": "2025-01-15",
        "previousSuccessfulOrdersAtSameAddress": true,
        "redemptionRateLastHalfYear": "123.45",
        "registrationDate": "2025-01-15"
      },
      "deviceId": "example",
      "isExpressShipping": true,
      "merchantMcc": "example",
      "merchantName": "example",
      "merchantOfflinePosLegalAddress": "example",
      "merchantTaxRefNumber": "example",
      "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": "example",
      "shippingAddress": "example",
      "shippingPhone": "71234567890",
      "shippingType": "COURIER"
    }
    

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

Example
{
  "billingPhone": "example",
  "customerAggregates": {
    "amountFirstSuccessfulOrder": "123.45",
    "amountLatestSuccessfulOrder": "123.45",
    "cookie": "example",
    "daysSinceLastPasswordReset": 0,
    "failedLoginAttemptsOneDay": 0,
    "failedLoginAttemptsSevenDays": 0,
    "firstSuccessfulOrderDate": "2025-01-15",
    "historicalCookieLogin": true,
    "historicalDeviceLogin": true,
    "lastPasswordResetDate": "2025-01-15",
    "latestSuccessfulOrderLastYearDate": "2025-01-15",
    "previousSuccessfulOrdersAtSameAddress": true,
    "redemptionRateLastHalfYear": "123.45",
    "registrationDate": "2025-01-15"
  },
  "deviceId": "example",
  "isExpressShipping": true,
  "merchantMcc": "example",
  "merchantName": "example",
  "merchantOfflinePosLegalAddress": "example",
  "merchantTaxRefNumber": "example",
  "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": "example",
  "shippingAddress": "example",
  "shippingPhone": "71234567890",
  "shippingType": "COURIER"
}

ttl

Type: integer

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

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

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

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

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

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

Default: 1800

CartItemFeatures

Name

Description

pointsDisabled

Type: boolean

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

Default: false

tariffModifier

Type: string

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

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

Example: VERY_LOW

Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

ItemQuantity

Name

Description

count

Type: string<double>

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Example: 123.45

available

Type: string<double>

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

Example: 123.45

Example
{
  "available": "123.45",
  "count": "123.45"
}

PaymentsOperator

Name

Description

phones

Type: string[]

Example
[
  "example"
]
Example
{
  "phones": [
    "example"
  ]
}

TransferOperator

Name

Description

address

Type: string

Max length: 2048

Example: example

inn

Type: string

Max length: 2048

Example: example

name

Type: string

Max length: 2048

Example: example

phones

Type: string[]

Example
[
  "example"
]
Example
{
  "address": "example",
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

Agent

Name

Description

agentType

Type: integer

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

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

operation

Type: string

Max length: 2048

Example: example

paymentsOperator

Type: PaymentsOperator

Example
{
  "phones": [
    "example"
  ]
}

phones

Type: string[]

Example
[
  "example"
]

transferOperator

Type: TransferOperator

Example
{
  "address": "example",
  "inn": "example",
  "name": "example",
  "phones": [
    "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: 2048

Example: example

name

Type: string

Max length: 2048

Example: example

phones

Type: string[]

Example
[
  "example"
]
Example
{
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

ItemReceipt

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

Name

Description

tax

Type: integer

Ставка НДС. Описание значений: Ссылка.

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

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

agent

Type: Agent

Example
{
  "agentType": 1,
  "operation": "example",
  "paymentsOperator": {
    "phones": [
      "example"
    ]
  },
  "phones": [
    "example"
  ],
  "transferOperator": {
    "address": "example",
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  }
}

excise

Type: string<double>

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

Example: 123.45

markQuantity

Type: MarkQuantity

Example
{
  "denominator": 0,
  "numerator": 0
}

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 байт)

Example: example

supplier

Type: Supplier

Example
{
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

title

Type: string

Max length: 2048

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

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Max length: 2048

Example: example

quantity

All of 1 type
  • Type: ItemQuantity

    Example
    {
      "available": "123.45",
      "count": "123.45"
    }
    

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Example
{
  "available": "123.45",
  "count": "123.45"
}

title

Type: string

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Max length: 2048

Example: example

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

Example: example

discountedUnitPrice

Type: string<double>

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

Example: 123.45

features

All of 1 type
  • Type: CartItemFeatures

    Example
    {
      "pointsDisabled": false,
      "tariffModifier": "VERY_LOW"
    }
    

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

Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

receipt

All of 1 type
  • Type: ItemReceipt

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

    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"
    }
    

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

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"
}

skuId

Type: string

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

Max length: 2048

Example: example

subtotal

Type: string<double>

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

Example: 123.45

unitPrice

Type: string<double>

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

Example: 123.45

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

externalAmount

Type: string<double>

Сумма внешней оплаты (сертификаты, подарочные карты, баллы лояльности).

Может быть не указана, равна 0 или больше 0.

Ограничения:

  • Нельзя создать заказ с amount: "0" (полная оплата внешними средствами). Минимальная сумма для оплаты через Яндекс Пэй — 1 рубль.
  • Сумма amount + externalAmount должна равняться сумме всех items в корзине.
  • (Для двухстадийных платежей) При списании средств методом /orders/{order_id}/capture не должна превышать значение, переданное в /orders при создании заказа.

Example: 123.45

Example
{
  "amount": "123.45",
  "externalAmount": "123.45"
}

RenderedCart

Примечание

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

Важно

В соответствии с Федеральным законом № 283‑ФЗ «О деятельности по предоставлению сервиса рассрочки» при использовании сервиса Сплит договор о предоставлении сервиса рассрочки с пользователем обязательно должен содержать сведения об объекте рассрочки — товарах, работах, услугах или результатах интеллектуальной деятельности, оплачиваемых в Сплит.

Поэтому в запросе обязательно передавайте данные всех объектов рассрочки в корзине в параметре cart.items.

Name

Description

items

Type: RenderedCartItem[]

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

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
        ],
        "transferOperator": {}
      },
      "excise": "123.45",
      "markQuantity": {
        "denominator": 0,
        "numerator": 0
      },
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": {
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      },
      "tax": 1,
      "title": "example"
    },
    "skuId": "example",
    "subtotal": "123.45",
    "title": "example",
    "total": "123.45",
    "unitPrice": "123.45"
  }
]

total

All of 1 type
  • Type: CartTotal

    Example
    {
      "amount": "123.45",
      "externalAmount": "123.45"
    }
    

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Example
{
  "amount": "123.45",
  "externalAmount": "123.45"
}

externalId

Type: string

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

Max length: 2048

Example: 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"
  }
}

BillingReport

Name

Description

branchId

Type: string

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

Default: null

Max length: 2048

managerId

Type: string

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

Default: null

Max length: 2048

Example
{
  "branchId": "null",
  "managerId": "null"
}

PaymentData

Name

Description

saleToken

Type: string

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

Max length: 2048

Example: example

Example
{
  "saleToken": "example"
}

QRData

Name

Description

token

Type: string

QR токен

Max length: 2048

Example: example

Example
{
  "token": "example"
}

SMSOffer

Name

Description

phone

Type: string

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

Max length: 2048

Pattern: ^\+\d+$

Example: example

Example
{
  "phone": "example"
}

OrderExtensions

Name

Description

billingReport

All of 1 type
  • Type: BillingReport

    Example
    {
      "branchId": "null",
      "managerId": "null"
    }
    

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

Example
{
  "branchId": "null",
  "managerId": "null"
}

paymentData

All of 1 type

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

Example
{
  "saleToken": "example"
}

qrData

All of 1 type
  • Type: QRData

    Example
    {
      "token": "example"
    }
    

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

Example
{
  "token": "example"
}

smsOffer

All of 1 type
  • Type: SMSOffer

    Example
    {
      "phone": "example"
    }
    

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

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

Example
{
  "phone": "example"
}
Example
{
  "billingReport": {
    "branchId": "null",
    "managerId": "null"
  },
  "paymentData": {
    "saleToken": "example"
  },
  "qrData": {
    "token": "example"
  },
  "smsOffer": {
    "phone": "example"
  }
}

MerchantRedirectUrls

Примечание

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

Name

Description

onError

Type: string

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

Max length: 2048

Example: example

onSuccess

Type: string

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

Max length: 2048

Example: example

onAbort

Type: string

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

Max length: 2048

Example: example

Example
{
  "onAbort": "example",
  "onError": "example",
  "onSuccess": "example"
}

CustomerAggregates

Name

Description

amountFirstSuccessfulOrder

Type: string<double>

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

Example: 123.45

amountLatestSuccessfulOrder

Type: string<double>

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

Example: 123.45

cookie

Type: string

Куки

Max length: 2048

Example: example

daysSinceLastPasswordReset

Type: integer

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

failedLoginAttemptsOneDay

Type: integer

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

failedLoginAttemptsSevenDays

Type: integer

Количество неуспешных попыток входа за последние 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

Example
{
  "amountFirstSuccessfulOrder": "123.45",
  "amountLatestSuccessfulOrder": "123.45",
  "cookie": "example",
  "daysSinceLastPasswordReset": 0,
  "failedLoginAttemptsOneDay": 0,
  "failedLoginAttemptsSevenDays": 0,
  "firstSuccessfulOrderDate": "2025-01-15",
  "historicalCookieLogin": true,
  "historicalDeviceLogin": true,
  "lastPasswordResetDate": "2025-01-15",
  "latestSuccessfulOrderLastYearDate": "2025-01-15",
  "previousSuccessfulOrdersAtSameAddress": true,
  "redemptionRateLastHalfYear": "123.45",
  "registrationDate": "2025-01-15"
}

PeriodCheckAggregates

Name

Description

successfulOrdersCountNineMonths

Type: integer

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

successfulOrdersCountOneMonth

Type: integer

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

successfulOrdersCountSixMonths

Type: integer

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

successfulOrdersCountThreeMonths

Type: integer

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

successfulOrdersCountTwelveMonths

Type: integer

Количество успешных заказов за последние 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

Example
{
  "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"
}

MerchantRiskInfo

Name

Description

billingPhone

Type: string

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

Max length: 2048

Example: example

customerAggregates

All of 1 type
  • Type: CustomerAggregates

    Example
    {
      "amountFirstSuccessfulOrder": "123.45",
      "amountLatestSuccessfulOrder": "123.45",
      "cookie": "example",
      "daysSinceLastPasswordReset": 0,
      "failedLoginAttemptsOneDay": 0,
      "failedLoginAttemptsSevenDays": 0,
      "firstSuccessfulOrderDate": "2025-01-15",
      "historicalCookieLogin": true,
      "historicalDeviceLogin": true,
      "lastPasswordResetDate": "2025-01-15",
      "latestSuccessfulOrderLastYearDate": "2025-01-15",
      "previousSuccessfulOrdersAtSameAddress": true,
      "redemptionRateLastHalfYear": "123.45",
      "registrationDate": "2025-01-15"
    }
    

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

Example
{
  "amountFirstSuccessfulOrder": "123.45",
  "amountLatestSuccessfulOrder": "123.45",
  "cookie": "example",
  "daysSinceLastPasswordReset": 0,
  "failedLoginAttemptsOneDay": 0,
  "failedLoginAttemptsSevenDays": 0,
  "firstSuccessfulOrderDate": "2025-01-15",
  "historicalCookieLogin": true,
  "historicalDeviceLogin": true,
  "lastPasswordResetDate": "2025-01-15",
  "latestSuccessfulOrderLastYearDate": "2025-01-15",
  "previousSuccessfulOrdersAtSameAddress": true,
  "redemptionRateLastHalfYear": "123.45",
  "registrationDate": "2025-01-15"
}

deviceId

Type: string

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

Max length: 2048

Example: example

isExpressShipping

Type: boolean

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

merchantMcc

Type: string

MCC мерчанта

Max length: 2048

Example: example

merchantName

Type: string

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

Max length: 2048

Example: example

merchantOfflinePosLegalAddress

Type: string

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

Max length: 2048

Example: example

merchantTaxRefNumber

Type: string

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

Max length: 2048

Example: example

periodCheckAggregates

All of 1 type
  • Type: PeriodCheckAggregates

    Example
    {
      "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"
    }
    

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

Example
{
  "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"
}

qrcId

Type: string

ID QR-кода

Max length: 2048

Example: example

qrType

Type: string

Тип QR-кода

Enum: static, dynamic, null

Example: static

shippingAddress

Type: string

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

Max length: 2048

Example: example

shippingPhone

Type: string

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

Max length: 2048

Example: 71234567890

shippingType

Type: string

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

Enum: COURIER, PICKUP, null

Example: COURIER

Example
{
  "billingPhone": "example",
  "customerAggregates": {
    "amountFirstSuccessfulOrder": "123.45",
    "amountLatestSuccessfulOrder": "123.45",
    "cookie": "example",
    "daysSinceLastPasswordReset": 0,
    "failedLoginAttemptsOneDay": 0,
    "failedLoginAttemptsSevenDays": 0,
    "firstSuccessfulOrderDate": "2025-01-15",
    "historicalCookieLogin": true,
    "historicalDeviceLogin": true,
    "lastPasswordResetDate": "2025-01-15",
    "latestSuccessfulOrderLastYearDate": "2025-01-15",
    "previousSuccessfulOrdersAtSameAddress": true,
    "redemptionRateLastHalfYear": "123.45",
    "registrationDate": "2025-01-15"
  },
  "deviceId": "example",
  "isExpressShipping": true,
  "merchantMcc": "example",
  "merchantName": "example",
  "merchantOfflinePosLegalAddress": "example",
  "merchantTaxRefNumber": "example",
  "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": "example",
  "shippingAddress": "example",
  "shippingPhone": "71234567890",
  "shippingType": "COURIER"
}

Responses

200 OK

Body

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

Name

Description

data

Type: CreateOrderResponseData

Example
{
  "paymentUrl": "example"
}

code

Type: unknown

Default: 200

status

Type: string

Default: success

Const: success

RenderedCartItem

Name

Description

productId

Type: string

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Max length: 2048

Example: example

quantity

All of 1 type
  • Type: ItemQuantity

    Example
    {
      "available": "123.45",
      "count": "123.45"
    }
    

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Example
{
  "available": "123.45",
  "count": "123.45"
}

title

Type: string

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Max length: 2048

Example: example

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

Example: example

discountedUnitPrice

Type: string<double>

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

Example: 123.45

features

All of 1 type
  • Type: CartItemFeatures

    Example
    {
      "pointsDisabled": false,
      "tariffModifier": "VERY_LOW"
    }
    

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

Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

pointsAmount

Type: string<double>

Количество баллов Плюса

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

Example: 123.45

receipt

All of 1 type
  • Type: ItemReceipt

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

    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"
    }
    

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

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"
}

skuId

Type: string

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

Max length: 2048

Example: example

subtotal

Type: string<double>

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

Example: 123.45

unitPrice

Type: string<double>

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

Example: 123.45

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

externalAmount

Type: string<double>

Сумма внешней оплаты (сертификаты, подарочные карты, баллы лояльности).

Может быть не указана, равна 0 или больше 0.

Ограничения:

  • Нельзя создать заказ с amount: "0" (полная оплата внешними средствами). Минимальная сумма для оплаты через Яндекс Пэй — 1 рубль.
  • Сумма amount + externalAmount должна равняться сумме всех items в корзине.
  • (Для двухстадийных платежей) При списании средств методом /orders/{order_id}/capture не должна превышать значение, переданное в /orders при создании заказа.

Example: 123.45

pointsAmount

Type: string<double>

Количество баллов Плюса

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

Example: 123.45

Example
{
  "amount": "123.45",
  "externalAmount": "123.45",
  "pointsAmount": "123.45"
}

RenderedCart

Примечание

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

Важно

В соответствии с Федеральным законом № 283‑ФЗ «О деятельности по предоставлению сервиса рассрочки» при использовании сервиса Сплит договор о предоставлении сервиса рассрочки с пользователем обязательно должен содержать сведения об объекте рассрочки — товарах, работах, услугах или результатах интеллектуальной деятельности, оплачиваемых в Сплит.

Поэтому в запросе обязательно передавайте данные всех объектов рассрочки в корзине в параметре cart.items.

Name

Description

items

Type: RenderedCartItem[]

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

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
        ],
        "transferOperator": {}
      },
      "excise": "123.45",
      "markQuantity": {
        "denominator": 0,
        "numerator": 0
      },
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": {
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      },
      "tax": 1,
      "title": "example"
    },
    "skuId": "example",
    "subtotal": "123.45",
    "title": "example",
    "total": "123.45",
    "unitPrice": "123.45"
  }
]

total

All of 1 type
  • Type: CartTotal

    Example
    {
      "amount": "123.45",
      "externalAmount": "123.45",
      "pointsAmount": "123.45"
    }
    

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Example
{
  "amount": "123.45",
  "externalAmount": "123.45",
  "pointsAmount": "123.45"
}

externalId

Type: string

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

Max length: 2048

Example: 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"
  }
}

CreateOrderResponseData

Name

Description

paymentUrl

Type: string

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

Max length: 2048

Example: example

Example
{
  "paymentUrl": "example"
}
Предыдущая
Следующая