Yandex Pay API
version: 1.0.0
Передавайте следующие HTTP заголовки в ваших запросах:
- X-Request-Id: <уникальный идентификатор запроса>
- X-Request-Timeout: <таймаут запроса в миллисекундах>
- X-Request-Attempt: <номер попытки (0 — первая попытка, 1, 2 и т.д. — перезапросы)>
X-Request-Id нужен для отладки запросов, а также для обеспечения идемпотентности пишущих запросов.
Поэтому одно и то же значение X-Request-Id должно сохраняться во всех перезапросах при получении
ошибок с HTTP-кодами 5xx, либо 429 в ответ.
X-Request-Timeout нужен для deadline propagation
во время обработки запроса в системе.
Не используйте значения таймаутов меньше секунды. Максимальное значение таймаута — 10 секунд.
X-Request-Attempt полезен для общей диагностики.
Аутентификация запроса продавца
Для использования API необходимо получить аутентификационный API-ключ.
Токен необходимо передавать для каждого запроса в HTTP-заголовке Authorization.
Управление ключами находится в консоли Яндекс Пэй.
При этом в sandbox окружении API-ключ равен значению merchant_id.
--header 'Authorization: Api-Key <значение ключа>'
Если в запросе отсутствует токен или передан недействительный токен,
сервер возвращает HTTP-статус 401 Unauthorized.
Sections
Specification
Open API
{
"components": {
"schemas": {
"Agent": {
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
},
"BillingReport": {
"properties": {
"branchId": {
"default": null,
"description": "Обязательное поле только для офлайн-магазинов. Идентификатор точки продаж",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"default": null,
"description": "Обязательное поле только для офлайн-магазинов. Идентификатор менеджера",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
},
"CancelOrderRequest": {
"properties": {
"externalOperationId": {
"description": "Идентификатор операции",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "Причина отмены",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"CaptureRequest": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Внутренний идентификатор корзины Яндекс Пэй.\n\nБэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса `/order/create`. Если бэкенд магазина получает повторный запрос `/order/create`, то необходимо вернуть уже созданный номер заказа. На одну корзину (`cartId`) бэкенд магазина может создать не больше одного заказа (`orderId`).",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Купоны, применённые к корзине",
"items": {
"properties": {
"description": {
"description": "Описание. Например, \"Скидка 3%\"",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Код купона",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Скидки, применённые к корзине",
"items": {
"properties": {
"amount": {
"description": "Сумма скидки",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Текстовое описание",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Идентификатор скидки в системе мерчанта",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Переданный продавцом идентификатор корзины",
"maxLength": 2048,
"type": "string"
},
"items": {
"items": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Размеры и вес товара. Обязательно для товара типа `PHYSICAL`"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Тип товара. Важен для интеграции с доставками",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Итоговая корзина"
},
"externalOperationId": {
"description": "Идентификатор операции",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Сумма к списанию. Если не указана, будет списана итоговая стоимость переданной корзины",
"example": "123.45",
"format": "double",
"type": "string"
},
"shipping": {
"allOf": [
{
"properties": {
"amount": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
}
},
"required": [
"amount",
"methodType"
],
"type": "object"
}
],
"description": "Итоговый способ доставки"
}
},
"type": "object"
},
"Cart": {
"properties": {
"cartId": {
"description": "Внутренний идентификатор корзины Яндекс Пэй.\n\nБэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса `/order/create`. Если бэкенд магазина получает повторный запрос `/order/create`, то необходимо вернуть уже созданный номер заказа. На одну корзину (`cartId`) бэкенд магазина может создать не больше одного заказа (`orderId`).",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Купоны, применённые к корзине",
"items": {
"properties": {
"description": {
"description": "Описание. Например, \"Скидка 3%\"",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Код купона",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Скидки, применённые к корзине",
"items": {
"properties": {
"amount": {
"description": "Сумма скидки",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Текстовое описание",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Идентификатор скидки в системе мерчанта",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Переданный продавцом идентификатор корзины",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Позиция корзины",
"items": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"finalPrice": {
"description": "Цена за единицу товара с учётом всех скидок на позицию и на корзину",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Размеры и вес товара. Обязательно для товара типа `PHYSICAL`"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Тип товара. Важен для интеграции с доставками",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Итоговая стоимость корзины, которая пойдет в оплату"
}
},
"required": [
"items"
],
"type": "object"
},
"CartItem": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"finalPrice": {
"description": "Цена за единицу товара с учётом всех скидок на позицию и на корзину",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Размеры и вес товара. Обязательно для товара типа `PHYSICAL`"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Тип товара. Важен для интеграции с доставками",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"CartItemFeatures": {
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
},
"CartItemWithoutFinalPriceCamelCase": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Размеры и вес товара. Обязательно для товара типа `PHYSICAL`"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Тип товара. Важен для интеграции с доставками",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"CartTotal": {
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
},
"CartWithRequiredTotalWithoutFinalPrice": {
"properties": {
"cartId": {
"description": "Внутренний идентификатор корзины Яндекс Пэй.\n\nБэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса `/order/create`. Если бэкенд магазина получает повторный запрос `/order/create`, то необходимо вернуть уже созданный номер заказа. На одну корзину (`cartId`) бэкенд магазина может создать не больше одного заказа (`orderId`).",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Купоны, применённые к корзине",
"items": {
"properties": {
"description": {
"description": "Описание. Например, \"Скидка 3%\"",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Код купона",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Скидки, применённые к корзине",
"items": {
"properties": {
"amount": {
"description": "Сумма скидки",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Текстовое описание",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Идентификатор скидки в системе мерчанта",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Переданный продавцом идентификатор корзины",
"maxLength": 2048,
"type": "string"
},
"items": {
"items": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Размеры и вес товара. Обязательно для товара типа `PHYSICAL`"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Тип товара. Важен для интеграции с доставками",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"required": [
"items",
"total"
],
"type": "object"
},
"CheckSubscriptionUserCardActivated": {
"properties": {
"check_card_active": {
"description": "Позволяет проверить привязку карты",
"type": "boolean"
}
},
"type": "object"
},
"Coupon": {
"properties": {
"description": {
"description": "Описание. Например, \"Скидка 3%\"",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Код купона",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"CourierOption": {
"properties": {
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"courierOptionId": {
"description": "id выбранного варианта доставки в системе продавца",
"maxLength": 2048,
"type": "string"
},
"customerChoice": {
"allOf": [
{
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"allOf": [
{
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
]
}
},
"required": [
"date"
],
"type": "object"
}
],
"description": "Выбранные пользователем дата и интервал. Только для `type: FLEXIBLE`"
},
"fromDate": {
"description": "Ближайшая дата доставки для `type: PLAIN`. Начало интервала выбора даты доставки для `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"fromTime": {
"description": "Начало интервала времени доставки. Только для `type: PLAIN`",
"type": "string"
},
"provider": {
"description": "Тип службы доставки.",
"enum": [
"BOXBERRY",
"CDEK",
"RUSSIAN_POST",
"EMS",
"COURIER",
"DHL",
"EXPRESS_DELIVERY",
"FIVEPOST",
"OZON_ROCKET",
"DPD",
"SBER_LOGISTICS",
"PEK",
"PICKPOINT",
"KCE",
"PONY_EXPRESS",
"YANDEX_DELIVERY",
null
],
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"timeIntervals": {
"allOf": [
{
"properties": {
"grid": {
"allOf": [
{
"properties": {
"duration": {
"description": "Продолжительность каждого интервала",
"type": "string"
},
"end": {
"description": "Максимальное время начала самого последнего интервала",
"type": "string"
},
"start": {
"description": "Время начала самого первого интервала",
"type": "string"
},
"step": {
"description": "Разница во времени между началами двух соседних интервалов",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
}
],
"description": "Кодирует интервалы в виде сетки. Используйте этот формат, если необходимо задать больше 20 интервалов доставки.\nПример: `{\"start\": \"09:00\", \"end\": \"21:00\", \"duration\": \"00:20\", \"step\": \"01:00\"}` трактуется как набор интервалов: `[{\"start\": \"09:00\", \"end\": \"09:20\"}, {\"start\": \"10:00\", \"end\": \"10:20\"}, ..., {\"start\": \"20:00\", \"end\": \"20:20\"}]`"
},
"type": {
"description": "Если указан тип `GRID`, то необходимо задать поле `grid`. Если указан тип `VALUES`, то необходимо задать поле `values`",
"enum": [
"GRID",
"VALUES"
],
"type": "string"
},
"values": {
"description": "Задаёт список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 20",
"items": {
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "Кодирует интервалы времени доставки, доступные для выбора. Только для `type: FLEXIBLE`"
},
"title": {
"description": "Название способа доставки. Показывается пользователю в списке вариантов",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "Самая поздняя дата доставки для `type: PLAIN`. Конец интервала выбора даты доставки для `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"toTime": {
"description": "Конец интервала времени доставки. Только для `type: PLAIN`",
"type": "string"
},
"type": {
"default": "PLAIN",
"description": "Тип опции.\nДля `FLEXIBLE` вариантов доставки пользователю дается возможность выбрать желаемые дату и интервал:\n- дата доставки выбирается покупателем в отрезке `[fromDate, toDate]`\n- чтобы предоставить пользователю выбор интервала в течении дня, заполните `timeIntervals`\nДля `PLAIN` вариантов такой выбор отсутствует.",
"enum": [
"PLAIN",
"FLEXIBLE"
],
"type": "string"
}
},
"required": [
"amount",
"category",
"courierOptionId",
"title"
],
"type": "object"
},
"CreateOrderRequest": {
"properties": {
"availablePaymentMethods": {
"default": null,
"description": "Доступные методы оплаты на платежной форме Яндекс Пэй.\n\nЕсли вы интегрируете оплату только одним методом, например, Карта — указывается один метод `[\"CARD\"]`. Для платежей по банковским картам и через Сплит необходимо передать: `[\"CARD\", \"SPLIT\"]`.",
"items": {
"enum": [
"CARD",
"SPLIT"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"billingPhone": {
"description": "Номер телефона клиента.\n\nИспользуется для упрощения авторизации, а также может увеличить вероятность одобрения по Сплиту.\n\nДля номера телефона предлагаем использовать формат `+71234567890` или `71234567890`. В строке допустимо наличие других символов, однако все символы, кроме цифр, игнорируются. Если номер телефона начинается с `8`, то он обрабатывается как аналогичный номер, где `8` заменена на `+7`.\n\nНапример, такие переданные значения `71234567890`, `+71234567890`, `81234567890`, `+7 (123) 456-78-90` будут обрабатываться как `71234567890`.",
"maxLength": 2048,
"type": "string"
},
"cart": {
"allOf": [
{
"properties": {
"externalId": {
"description": "Переданный продавцом идентификатор корзины",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Корзина товаров, которую оплачивает покупатель.",
"items": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Итоговая информация о стоимости заказа."
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Корзина"
},
"currencyCode": {
"description": "Трехбуквенный код валюты заказа (ISO 4217)",
"enum": [
"RUB"
],
"maxLength": 2048,
"type": "string"
},
"extensions": {
"allOf": [
{
"properties": {
"billingReport": {
"allOf": [
{
"properties": {
"branchId": {
"default": null,
"description": "Обязательное поле только для офлайн-магазинов. Идентификатор точки продаж",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"default": null,
"description": "Обязательное поле только для офлайн-магазинов. Идентификатор менеджера",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
}
],
"description": "Информация о месте и авторе оформления заказа."
},
"qrData": {
"allOf": [
{
"properties": {
"token": {
"description": "QR токен",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
}
],
"description": "Дополнительные параметры для отправки ссылки на оплату с использованием QR"
},
"smsOffer": {
"allOf": [
{
"properties": {
"phone": {
"description": "Номер телефона клиента (пример `+71234567890`) для СМС-информирования. Только для merchantId офлайн-магазина.",
"maxLength": 2048,
"pattern": "^\\+\\d+$",
"type": "string"
}
},
"required": [
"phone"
],
"type": "object"
}
],
"description": "Дополнительные параметры для отправки ссылки на оплату с использованием SMS.\n\nОбязательное поле только для офлайн-магазинов."
}
},
"type": "object"
}
],
"default": null,
"description": "Дополнительные параметры для оформления офлайн заказа"
},
"isPrepayment": {
"description": "Проводить ли заказ по флоу \"отложенно оплаты\".\n\nЕсли параметр установлен в `true`, то заказ будет оформлятся как заказ с отложенной оплатой, смотри раздел \"Способы оплаты и платёжные механики\".",
"type": "boolean"
},
"metadata": {
"description": "Произвольные данные по заказу для внутреннего использования",
"maxLength": 2048,
"type": "string"
},
"orderId": {
"description": "Идентификатор заказа на стороне продавца (должен быть уникальным). Дальнейшее взаимодействие по заявке на оплату будет осуществляться с использованием этого идентификатора. Также данный идентификатор будет использоваться в сверках",
"maxLength": 2048,
"type": "string"
},
"orderSource": {
"default": null,
"description": "Поверхность на которой инициализировали создание заказа\n\nНеобходимо для последующей аналитики\n\n---\n\n**WEBSITE**: Кнопка размещена на сайте. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя на сайте\n\n**APP**: Кнопка размещена в мобильном приложении. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя в приложении\n\n**CRM**: Ссылка на оплату сформирована менеджером в CRM или другой админке\n\n**CASH_REGISTER**: Ссылка на оплату сформирована для отображения на офлайн-кассе",
"enum": [
"WEBSITE",
"APP",
"CRM",
"CASH_REGISTER"
],
"type": "string"
},
"preferredPaymentMethod": {
"description": "Предпочтительный метод оплаты.\n\nПереданный метод будет автоматически выбран на форме оплаты, если это не противоречит доступным методам оплаты. По умолчанию - Карта.",
"enum": [
"FULLPAYMENT",
"SPLIT"
],
"type": "string"
},
"publicConstructor": {
"description": "Конструктор предвыбранного плана для оплаты в Сплит.\n\n_Доступно только по согласованию_",
"type": "string"
},
"purpose": {
"description": "Назначение платежа",
"maxLength": 1000,
"type": "string"
},
"redirectUrls": {
"allOf": [
{
"properties": {
"onAbort": {
"description": "Ссылка для переадресации пользователя в случае отмены процесса оплаты. Отмену оплаты осуществляет пользователь на форме для оплаты.",
"maxLength": 2048,
"type": "string"
},
"onError": {
"description": "Обязательное поле только для онлайн-магазинов. Ссылка для переадресации пользователя в случае возникновения ошибки во время оплаты, или если срок ссылки на оплату истек.",
"maxLength": 2048,
"type": "string"
},
"onSuccess": {
"description": "Обязательное поле только для онлайн-магазинов. Ссылка для переадресации пользователя в случае успешной оплаты.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"onError",
"onSuccess"
],
"type": "object"
}
],
"description": "Ссылки для переадресации пользователя с формы оплаты. Обязательно для онлайн продавца"
},
"risk": {
"allOf": [
{
"properties": {
"billingPhone": {
"description": "**DEPRECATED** Номер телефона клиента.<br/>*Cледует использовать одноименное поле на уровень выше.*",
"maxLength": 2048,
"type": "string"
},
"deviceId": {
"description": "Идентификатор устройства клиента (device_id/gaid/idfa/ifv)",
"maxLength": 2048,
"type": "string"
},
"shippingAddress": {
"description": "Адрес доставки",
"maxLength": 2048,
"type": "string"
},
"shippingPhone": {
"description": "Номер телефона получателя (пример +71234567890)",
"maxLength": 2048,
"type": "string"
},
"shippingType": {
"description": "Способ получения заказа",
"enum": [
"COURIER",
"PICKUP",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Дополнительная информация, наличие которой может увеличить вероятность одобрения по Сплиту. Доступно в полной мере только для онлайн-магазинов."
},
"ttl": {
"default": 1800,
"description": "Параметр определяет время, в течение которого пользователь может воспользоваться ссылкой на форму оплаты заказа.\n\nПо истечении времени пользователь будет видеть сообщение \"Вышло время оплаты\".\n\nЕсли пользователь воспользовался ссылкой до истечения времени, то на завершение оплаты отводится дополнительно 15 минут. Если по истечении дополнительного времени оплата не произошла, заказ считается не оплаченным окончательно.\n\nЭто отражается в изменении статуса заказа `Order.paymentStatus` на значение `FAILED`. Также выполняется отправка [уведомления](../custom/backend/merchant-api/webhook) об изменении статуса заказа. Если продавец бронировал товар, то после изменения статуса заказ можно отменить.\n\nВремя жизни (сек): `180 <= ttl <= 604800`\n\nВремя жизни (при создании ссылки в личном кабинете, сек): `86400`",
"format": "int32",
"type": "integer"
},
"uniqrMetadata": {
"allOf": [
{
"properties": {
"uniQrId": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"uniQrId"
],
"type": "object"
}
],
"description": "Дополнительные данные uniqr"
}
},
"required": [
"cart",
"currencyCode",
"orderId"
],
"type": "object"
},
"CreateOrderResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"paymentUrl": {
"description": "Ссылка на оплату заказа",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
},
"CreateOrderResponseData": {
"properties": {
"paymentUrl": {
"description": "Ссылка на оплату заказа",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl"
],
"type": "object"
},
"CreateSubscriptionRequest": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"externalId": {
"description": "Переданный продавцом идентификатор корзины",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Корзина товаров, которую оплачивает покупатель.",
"items": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Итоговая информация о стоимости заказа."
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Корзина"
},
"currencyCode": {
"description": "Трехбуквенный код валюты заказа (ISO 4217)",
"enum": [
"RUB"
],
"maxLength": 2048,
"type": "string"
},
"futureWriteOffAmount": {
"description": "Сумма, которую будет списана в будущем",
"example": "123.45",
"format": "double",
"type": "string"
},
"intervalCount": {
"description": "Количество периодов подписки, например \"списание каждые 6 месяцев\"\n\nОбязательно, если не указан параметр `isBinding=True`",
"format": "int32",
"type": "integer"
},
"intervalUnit": {
"description": "Единица времени в которой будет периодичность подписки\n\nОбязательно, если не указан параметр `isBinding=True`",
"enum": [
"SECOND",
"DAY",
"WEEK",
"MONTH",
"YEAR",
null
],
"type": "string"
},
"isBinding": {
"default": false,
"description": "Позволяет привязать карту пользователя без сформированной корзины товаров\n\nЕсли во время первого списания нужна только привязка карты, передайте в запросе параметр isBinding=true.\n\nКорзину и периодичность подписки в данном сценарии передавать не нужно.",
"type": "boolean"
},
"metadata": {
"description": "Произвольные данные по заказу для внутреннего использования",
"maxLength": 2048,
"type": "string"
},
"orderId": {
"description": "Идентификатор заказа на стороне продавца (должен быть уникальным). Дальнейшее взаимодействие по заявке на оплату будет осуществляться с использованием этого идентификатора. Также данный идентификатор будет использоваться в сверках",
"maxLength": 2048,
"type": "string"
},
"orderSource": {
"default": null,
"description": "Поверхность на который инициализацировали создание заказа\n\nНеобходимо для последующей аналитики\n\n---\n\n**WEBSITE**: Кнопка размещена на сайте. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя на сайте\n\n**APP**: Кнопка размещена в мобильном приложении. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя в приложении\n\n**CRM**: Ссылка на оплату сформирована менеджером в CRM или другой админке\n\n**CASH_REGISTER**: Ссылка на оплату сформирована для отображения на офлайн-кассе",
"enum": [
"WEBSITE",
"APP",
"CRM",
"CASH_REGISTER"
],
"type": "string"
},
"purpose": {
"description": "Назначение платежа",
"maxLength": 1000,
"type": "string"
},
"redirectUrls": {
"allOf": [
{
"properties": {
"onAbort": {
"description": "Ссылка для переадресации пользователя в случае отмены процесса оплаты. Отмену оплаты осуществляет пользователь на форме для оплаты.",
"maxLength": 2048,
"type": "string"
},
"onError": {
"description": "Обязательное поле только для онлайн-магазинов. Ссылка для переадресации пользователя в случае возникновения ошибки во время оплаты, или если срок ссылки на оплату истек.",
"maxLength": 2048,
"type": "string"
},
"onSuccess": {
"description": "Обязательное поле только для онлайн-магазинов. Ссылка для переадресации пользователя в случае успешной оплаты.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"onError",
"onSuccess"
],
"type": "object"
}
],
"description": "Ссылки для переадресации пользователя с формы оплаты. Обязательно для онлайн продавца"
},
"title": {
"description": "Название подписки",
"maxLength": 30,
"type": "string"
},
"trialCount": {
"description": "Количество периодов триального периода, например \"7 дней\"",
"format": "int32",
"type": "integer"
},
"trialEndAt": {
"description": "Дата окончания пробного периода. Взаимоисключающее с полями `trial_unit` + `trial_count`",
"format": "date-time",
"type": "string"
},
"trialUnit": {
"description": "Единица времени в которой будет периодичность триального периода",
"enum": [
"SECOND",
"DAY",
"WEEK",
"MONTH",
"YEAR",
null
],
"type": "string"
},
"ttl": {
"default": 1800,
"description": "Время жизни заказа (в секундах)\n\n`180 <= ttl <= 604800`",
"format": "int32",
"type": "integer"
}
},
"required": [
"currencyCode",
"orderId"
],
"type": "object"
},
"CreateSubscriptionResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"paymentUrl": {
"description": "Ссылка на оплату заказа",
"maxLength": 2048,
"type": "string"
},
"subscriptionId": {
"description": "Идентификатор подписки",
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl",
"subscriptionId"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
},
"CreateSubscriptionResponseData": {
"properties": {
"paymentUrl": {
"description": "Ссылка на оплату заказа",
"maxLength": 2048,
"type": "string"
},
"subscriptionId": {
"description": "Идентификатор подписки",
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl",
"subscriptionId"
],
"type": "object"
},
"CustomerSubscriptionResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"cancelledAt": {
"description": "Время отмены подписки",
"format": "date-time",
"type": "string"
},
"customerSubscriptionId": {
"description": "ID подписки",
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"isCardActive": {
"description": "Статус привязанной карты",
"type": "boolean"
},
"nextWriteOff": {
"description": "Дата следующего списания",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Статус подписки",
"enum": [
"NEW",
"ACTIVE",
"CANCELLED",
"EXPIRED"
],
"type": "string"
},
"subscriptionPlanId": {
"description": "ID плана подписки",
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"status",
"subscriptionPlanId"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
},
"CustomerSubscriptionResponseData": {
"properties": {
"cancelledAt": {
"description": "Время отмены подписки",
"format": "date-time",
"type": "string"
},
"customerSubscriptionId": {
"description": "ID подписки",
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"isCardActive": {
"description": "Статус привязанной карты",
"type": "boolean"
},
"nextWriteOff": {
"description": "Дата следующего списания",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Статус подписки",
"enum": [
"NEW",
"ACTIVE",
"CANCELLED",
"EXPIRED"
],
"type": "string"
},
"subscriptionPlanId": {
"description": "ID плана подписки",
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"status",
"subscriptionPlanId"
],
"type": "object"
},
"Delivery": {
"properties": {
"actualPrice": {
"description": "Цена доставки для продавца",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Дата и время создания доставки (ISO 8601)",
"format": "date-time",
"type": "string"
},
"price": {
"description": "Цена доставки для покупателя",
"example": "123.45",
"format": "double",
"type": "string"
},
"status": {
"default": "NEW",
"description": "Статус доставки",
"enum": [
"NEW",
"ESTIMATING",
"EXPIRED",
"READY_FOR_APPROVAL",
"COLLECTING",
"PREPARING",
"DELIVERING",
"DELIVERED",
"RETURNING",
"RETURNED",
"FAILED",
"CANCELLED"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления доставки (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"price"
],
"type": "object"
},
"Discount": {
"properties": {
"amount": {
"description": "Сумма скидки",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Текстовое описание",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Идентификатор скидки в системе мерчанта",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"FlexibleCustomerChoice": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"allOf": [
{
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
]
}
},
"required": [
"date"
],
"type": "object"
},
"FlexibleTimeIntervals": {
"properties": {
"grid": {
"allOf": [
{
"properties": {
"duration": {
"description": "Продолжительность каждого интервала",
"type": "string"
},
"end": {
"description": "Максимальное время начала самого последнего интервала",
"type": "string"
},
"start": {
"description": "Время начала самого первого интервала",
"type": "string"
},
"step": {
"description": "Разница во времени между началами двух соседних интервалов",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
}
],
"description": "Кодирует интервалы в виде сетки. Используйте этот формат, если необходимо задать больше 20 интервалов доставки.\nПример: `{\"start\": \"09:00\", \"end\": \"21:00\", \"duration\": \"00:20\", \"step\": \"01:00\"}` трактуется как набор интервалов: `[{\"start\": \"09:00\", \"end\": \"09:20\"}, {\"start\": \"10:00\", \"end\": \"10:20\"}, ..., {\"start\": \"20:00\", \"end\": \"20:20\"}]`"
},
"type": {
"description": "Если указан тип `GRID`, то необходимо задать поле `grid`. Если указан тип `VALUES`, то необходимо задать поле `values`",
"enum": [
"GRID",
"VALUES"
],
"type": "string"
},
"values": {
"description": "Задаёт список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 20",
"items": {
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"FlexibleTimeIntervalsGridDescriptor": {
"properties": {
"duration": {
"description": "Продолжительность каждого интервала",
"type": "string"
},
"end": {
"description": "Максимальное время начала самого последнего интервала",
"type": "string"
},
"start": {
"description": "Время начала самого первого интервала",
"type": "string"
},
"step": {
"description": "Разница во времени между началами двух соседних интервалов",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
},
"ItemQuantity": {
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
},
"ItemReceipt": {
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
},
"Location": {
"properties": {
"latitude": {
"format": "float",
"type": "number"
},
"longitude": {
"format": "float",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"MarkQuantity": {
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
},
"Measurements": {
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
},
"MerchantApiOrder": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Внутренний идентификатор корзины Яндекс Пэй.\n\nБэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса `/order/create`. Если бэкенд магазина получает повторный запрос `/order/create`, то необходимо вернуть уже созданный номер заказа. На одну корзину (`cartId`) бэкенд магазина может создать не больше одного заказа (`orderId`).",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Купоны, применённые к корзине",
"items": {
"properties": {
"description": {
"description": "Описание. Например, \"Скидка 3%\"",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Код купона",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Скидки, применённые к корзине",
"items": {
"properties": {
"amount": {
"description": "Сумма скидки",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Текстовое описание",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Идентификатор скидки в системе мерчанта",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Переданный продавцом идентификатор корзины",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Позиция корзины",
"items": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"finalPrice": {
"description": "Цена за единицу товара с учётом всех скидок на позицию и на корзину",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Размеры и вес товара. Обязательно для товара типа `PHYSICAL`"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Тип товара. Важен для интеграции с доставками",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Итоговая стоимость корзины, которая пойдет в оплату"
}
},
"required": [
"items"
],
"type": "object"
}
],
"description": "Корзина"
},
"created": {
"description": "Дата и время создания заказа (ISO 8601)",
"format": "date-time",
"type": "string"
},
"currencyCode": {
"description": "Трехбуквенный код валюты заказа (ISO 4217)",
"enum": [
"RUB"
],
"maxLength": 2048,
"type": "string"
},
"isPrepayment": {
"default": false,
"description": "Флаг, идет ли заказ по флоу \"отложенной оплаты\"",
"type": "boolean"
},
"merchantId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Произвольные данные, переданные при инициализации кнопки",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Полная стоимость заказа к оплате с учётом возвратов, доставки, скидок и промокодов",
"example": "123.45",
"format": "double",
"type": "string"
},
"orderId": {
"description": "Id существующего заказа на стороне продавца, переданный при инициализации кнопки",
"maxLength": 2048,
"type": "string"
},
"paymentMethod": {
"allOf": [
{
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Платежная система",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"CARD",
"SPLIT",
"SBP",
"SPLIT_SBP",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
}
],
"description": "Выбранный способ оплаты"
},
"paymentStatus": {
"enum": [
"PENDING",
"AUTHORIZED",
"CAPTURED",
"VOIDED",
"REFUNDED",
"CONFIRMED",
"PARTIALLY_REFUNDED",
"FAILED",
null
],
"type": "string",
"x-enumDescriptions": {
"AUTHORIZED": "Платеж за заказ авторизован. Средства заблокированы на счету плательщика",
"CAPTURED": "Заказ успешно оплачен. Средства списаны со счета плательщика",
"CONFIRMED": "Заказ успешно оформлен",
"FAILED": "Заказ не был успешно оплачен",
"PARTIALLY_REFUNDED": "Совершён частичный возврат средств за заказ",
"PENDING": "Ожидается оплата",
"REFUNDED": "Совершён возврат средств за заказ",
"VOIDED": "Оплата отменена (voided). Списание средств не производилось"
}
},
"paymentUrl": {
"description": "Ссылка на оплату заказа",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "причина (применимо для статусов VOIDED/FAILED)",
"maxLength": 2048,
"type": "string"
},
"shippingMethod": {
"allOf": [
{
"properties": {
"courierOption": {
"allOf": [
{
"properties": {
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"courierOptionId": {
"description": "id выбранного варианта доставки в системе продавца",
"maxLength": 2048,
"type": "string"
},
"customerChoice": {
"allOf": [
{
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"allOf": [
{
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
]
}
},
"required": [
"date"
],
"type": "object"
}
],
"description": "Выбранные пользователем дата и интервал. Только для `type: FLEXIBLE`"
},
"fromDate": {
"description": "Ближайшая дата доставки для `type: PLAIN`. Начало интервала выбора даты доставки для `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"fromTime": {
"description": "Начало интервала времени доставки. Только для `type: PLAIN`",
"type": "string"
},
"provider": {
"description": "Тип службы доставки.",
"enum": [
"BOXBERRY",
"CDEK",
"RUSSIAN_POST",
"EMS",
"COURIER",
"DHL",
"EXPRESS_DELIVERY",
"FIVEPOST",
"OZON_ROCKET",
"DPD",
"SBER_LOGISTICS",
"PEK",
"PICKPOINT",
"KCE",
"PONY_EXPRESS",
"YANDEX_DELIVERY",
null
],
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"timeIntervals": {
"allOf": [
{
"properties": {
"grid": {
"allOf": [
{
"properties": {
"duration": {
"description": "Продолжительность каждого интервала",
"type": "string"
},
"end": {
"description": "Максимальное время начала самого последнего интервала",
"type": "string"
},
"start": {
"description": "Время начала самого первого интервала",
"type": "string"
},
"step": {
"description": "Разница во времени между началами двух соседних интервалов",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
}
],
"description": "Кодирует интервалы в виде сетки. Используйте этот формат, если необходимо задать больше 20 интервалов доставки.\nПример: `{\"start\": \"09:00\", \"end\": \"21:00\", \"duration\": \"00:20\", \"step\": \"01:00\"}` трактуется как набор интервалов: `[{\"start\": \"09:00\", \"end\": \"09:20\"}, {\"start\": \"10:00\", \"end\": \"10:20\"}, ..., {\"start\": \"20:00\", \"end\": \"20:20\"}]`"
},
"type": {
"description": "Если указан тип `GRID`, то необходимо задать поле `grid`. Если указан тип `VALUES`, то необходимо задать поле `values`",
"enum": [
"GRID",
"VALUES"
],
"type": "string"
},
"values": {
"description": "Задаёт список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 20",
"items": {
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "Кодирует интервалы времени доставки, доступные для выбора. Только для `type: FLEXIBLE`"
},
"title": {
"description": "Название способа доставки. Показывается пользователю в списке вариантов",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "Самая поздняя дата доставки для `type: PLAIN`. Конец интервала выбора даты доставки для `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"toTime": {
"description": "Конец интервала времени доставки. Только для `type: PLAIN`",
"type": "string"
},
"type": {
"default": "PLAIN",
"description": "Тип опции.\nДля `FLEXIBLE` вариантов доставки пользователю дается возможность выбрать желаемые дату и интервал:\n- дата доставки выбирается покупателем в отрезке `[fromDate, toDate]`\n- чтобы предоставить пользователю выбор интервала в течении дня, заполните `timeIntervals`\nДля `PLAIN` вариантов такой выбор отсутствует.",
"enum": [
"PLAIN",
"FLEXIBLE"
],
"type": "string"
}
},
"required": [
"amount",
"category",
"courierOptionId",
"title"
],
"type": "object"
}
],
"description": "если methodType == COURIER"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
},
"pickupOption": {
"allOf": [
{
"properties": {
"address": {
"description": "Адрес в виде строки",
"maxLength": 2048,
"type": "string"
},
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки в точку",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Дополнительное описание",
"maxLength": 2048,
"type": "string"
},
"fromDate": {
"description": "YYYY-MM-DD. Ближайшая возможная дата доставки",
"format": "date",
"type": "string"
},
"location": {
"properties": {
"latitude": {
"format": "float",
"type": "number"
},
"longitude": {
"format": "float",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"phones": {
"description": "Телефоны для связи",
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"pickupPointId": {
"description": "Уникальный id точки самовывоза в системе продавца",
"maxLength": 2048,
"type": "string"
},
"provider": {
"description": "Тип точки вывоза.",
"enum": [
"YANDEX_MARKET",
"BOXBERRY",
"CDEK",
"IN_STORE",
"RUSSIAN_POST",
"PICKPOINT",
"DPD"
],
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"schedule": {
"description": "График работы точки",
"items": {
"properties": {
"fromTime": {
"description": "HH:mm, \"08:00\"",
"type": "string"
},
"label": {
"description": "Например, \"пн-пт\"",
"maxLength": 2048,
"type": "string"
},
"toTime": {
"description": "HH:mm, \"20:00\"",
"type": "string"
}
},
"required": [
"fromTime",
"label",
"toTime"
],
"type": "object"
},
"type": "array"
},
"storagePeriod": {
"description": "Опционально. Срок хранения товара в точке самовывоза в днях",
"format": "int32",
"type": "integer"
},
"title": {
"description": "Название точки самовывоза",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "YYYY-MM-DD. Самая поздняя дата доставки",
"format": "date",
"type": "string"
}
},
"required": [
"address",
"location",
"pickupPointId",
"title"
],
"type": "object"
}
],
"description": "если methodType == PICKUP"
},
"yandexDeliveryOption": {
"allOf": [
{
"properties": {
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"fromDatetime": {
"format": "date-time",
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"title": {
"description": "Название способа доставки. Показывается пользователю в списке вариантов",
"maxLength": 2048,
"type": "string"
},
"toDatetime": {
"format": "date-time",
"type": "string"
},
"yandexDeliveryOptionId": {
"description": "Id предложения Яндекс Доставки",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"category",
"title",
"yandexDeliveryOptionId"
],
"type": "object"
}
],
"description": "если methodType == YANDEX_DELIVERY"
}
},
"required": [
"methodType"
],
"type": "object"
}
],
"description": "Выбранный способ доставки"
},
"updated": {
"description": "Дата и время обновления заказа (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"cart",
"currencyCode"
],
"type": "object"
},
"MerchantOperationResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Сумма операции в фиатной валюте",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Дата и время создания операции (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Идентификатор операции на стороне продавца",
"maxLength": 2048,
"type": "string"
},
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"operationType": {
"enum": [
"AUTHORIZE",
"BIND_CARD",
"REFUND",
"CAPTURE",
"VOID",
"RECURRING",
"PREPAYMENT",
"SUBMIT"
],
"type": "string"
},
"orderId": {
"maxLength": 2048,
"type": "string"
},
"params": {
"type": "object"
},
"pointsAmount": {
"description": "Сумма операции в баллах Плюса",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Причина ошибки",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления операции (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
}
},
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
},
"MerchantOrderResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"delivery": {
"properties": {
"actualPrice": {
"description": "Цена доставки для продавца",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Дата и время создания доставки (ISO 8601)",
"format": "date-time",
"type": "string"
},
"price": {
"description": "Цена доставки для покупателя",
"example": "123.45",
"format": "double",
"type": "string"
},
"status": {
"default": "NEW",
"description": "Статус доставки",
"enum": [
"NEW",
"ESTIMATING",
"EXPIRED",
"READY_FOR_APPROVAL",
"COLLECTING",
"PREPARING",
"DELIVERING",
"DELIVERED",
"RETURNING",
"RETURNED",
"FAILED",
"CANCELLED"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления доставки (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"price"
],
"type": "object"
},
"operations": {
"items": {
"properties": {
"amount": {
"description": "Сумма операции в фиатной валюте",
"example": "123.45",
"format": "double",
"type": "string"
},
"approvalCode": {
"description": "Код подтверждения транзакции от процессингового центра.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "Дата и время создания операции (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Идентификатор операции на стороне продавца",
"maxLength": 2048,
"type": "string"
},
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"operationType": {
"enum": [
"AUTHORIZE",
"BIND_CARD",
"REFUND",
"CAPTURE",
"VOID",
"RECURRING",
"PREPAYMENT",
"SUBMIT"
],
"type": "string"
},
"orderId": {
"maxLength": 2048,
"type": "string"
},
"params": {
"type": "object"
},
"reason": {
"description": "Причина ошибки",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления операции (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"type": "array"
},
"order": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Внутренний идентификатор корзины Яндекс Пэй.\n\nБэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса `/order/create`. Если бэкенд магазина получает повторный запрос `/order/create`, то необходимо вернуть уже созданный номер заказа. На одну корзину (`cartId`) бэкенд магазина может создать не больше одного заказа (`orderId`).",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Купоны, применённые к корзине",
"items": {
"properties": {
"description": {
"description": "Описание. Например, \"Скидка 3%\"",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Код купона",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Скидки, применённые к корзине",
"items": {
"properties": {
"amount": {
"description": "Сумма скидки",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Текстовое описание",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Идентификатор скидки в системе мерчанта",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Переданный продавцом идентификатор корзины",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Позиция корзины",
"items": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"finalPrice": {
"description": "Цена за единицу товара с учётом всех скидок на позицию и на корзину",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Размеры и вес товара. Обязательно для товара типа `PHYSICAL`"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Тип товара. Важен для интеграции с доставками",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Итоговая стоимость корзины, которая пойдет в оплату"
}
},
"required": [
"items"
],
"type": "object"
}
],
"description": "Корзина"
},
"created": {
"description": "Дата и время создания заказа (ISO 8601)",
"format": "date-time",
"type": "string"
},
"currencyCode": {
"description": "Трехбуквенный код валюты заказа (ISO 4217)",
"enum": [
"RUB"
],
"maxLength": 2048,
"type": "string"
},
"isPrepayment": {
"default": false,
"description": "Флаг, идет ли заказ по флоу \"отложенной оплаты\"",
"type": "boolean"
},
"merchantId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Произвольные данные, переданные при инициализации кнопки",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Полная стоимость заказа к оплате с учётом возвратов, доставки, скидок и промокодов",
"example": "123.45",
"format": "double",
"type": "string"
},
"orderId": {
"description": "Id существующего заказа на стороне продавца, переданный при инициализации кнопки",
"maxLength": 2048,
"type": "string"
},
"paymentMethod": {
"allOf": [
{
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Платежная система",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"CARD",
"SPLIT",
"SBP",
"SPLIT_SBP",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
}
],
"description": "Выбранный способ оплаты"
},
"paymentStatus": {
"enum": [
"PENDING",
"AUTHORIZED",
"CAPTURED",
"VOIDED",
"REFUNDED",
"CONFIRMED",
"PARTIALLY_REFUNDED",
"FAILED",
null
],
"type": "string",
"x-enumDescriptions": {
"AUTHORIZED": "Платеж за заказ авторизован. Средства заблокированы на счету плательщика",
"CAPTURED": "Заказ успешно оплачен. Средства списаны со счета плательщика",
"CONFIRMED": "Заказ успешно оформлен",
"FAILED": "Заказ не был успешно оплачен",
"PARTIALLY_REFUNDED": "Совершён частичный возврат средств за заказ",
"PENDING": "Ожидается оплата",
"REFUNDED": "Совершён возврат средств за заказ",
"VOIDED": "Оплата отменена (voided). Списание средств не производилось"
}
},
"paymentUrl": {
"description": "Ссылка на оплату заказа",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "причина (применимо для статусов VOIDED/FAILED)",
"maxLength": 2048,
"type": "string"
},
"shippingMethod": {
"allOf": [
{
"properties": {
"courierOption": {
"allOf": [
{
"properties": {
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"courierOptionId": {
"description": "id выбранного варианта доставки в системе продавца",
"maxLength": 2048,
"type": "string"
},
"customerChoice": {
"allOf": [
{
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"allOf": [
{
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
]
}
},
"required": [
"date"
],
"type": "object"
}
],
"description": "Выбранные пользователем дата и интервал. Только для `type: FLEXIBLE`"
},
"fromDate": {
"description": "Ближайшая дата доставки для `type: PLAIN`. Начало интервала выбора даты доставки для `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"fromTime": {
"description": "Начало интервала времени доставки. Только для `type: PLAIN`",
"type": "string"
},
"provider": {
"description": "Тип службы доставки.",
"enum": [
"BOXBERRY",
"CDEK",
"RUSSIAN_POST",
"EMS",
"COURIER",
"DHL",
"EXPRESS_DELIVERY",
"FIVEPOST",
"OZON_ROCKET",
"DPD",
"SBER_LOGISTICS",
"PEK",
"PICKPOINT",
"KCE",
"PONY_EXPRESS",
"YANDEX_DELIVERY",
null
],
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"timeIntervals": {
"allOf": [
{
"properties": {
"grid": {
"allOf": [
{
"properties": {
"duration": {
"description": "Продолжительность каждого интервала",
"type": "string"
},
"end": {
"description": "Максимальное время начала самого последнего интервала",
"type": "string"
},
"start": {
"description": "Время начала самого первого интервала",
"type": "string"
},
"step": {
"description": "Разница во времени между началами двух соседних интервалов",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
}
],
"description": "Кодирует интервалы в виде сетки. Используйте этот формат, если необходимо задать больше 20 интервалов доставки.\nПример: `{\"start\": \"09:00\", \"end\": \"21:00\", \"duration\": \"00:20\", \"step\": \"01:00\"}` трактуется как набор интервалов: `[{\"start\": \"09:00\", \"end\": \"09:20\"}, {\"start\": \"10:00\", \"end\": \"10:20\"}, ..., {\"start\": \"20:00\", \"end\": \"20:20\"}]`"
},
"type": {
"description": "Если указан тип `GRID`, то необходимо задать поле `grid`. Если указан тип `VALUES`, то необходимо задать поле `values`",
"enum": [
"GRID",
"VALUES"
],
"type": "string"
},
"values": {
"description": "Задаёт список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 20",
"items": {
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "Кодирует интервалы времени доставки, доступные для выбора. Только для `type: FLEXIBLE`"
},
"title": {
"description": "Название способа доставки. Показывается пользователю в списке вариантов",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "Самая поздняя дата доставки для `type: PLAIN`. Конец интервала выбора даты доставки для `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"toTime": {
"description": "Конец интервала времени доставки. Только для `type: PLAIN`",
"type": "string"
},
"type": {
"default": "PLAIN",
"description": "Тип опции.\nДля `FLEXIBLE` вариантов доставки пользователю дается возможность выбрать желаемые дату и интервал:\n- дата доставки выбирается покупателем в отрезке `[fromDate, toDate]`\n- чтобы предоставить пользователю выбор интервала в течении дня, заполните `timeIntervals`\nДля `PLAIN` вариантов такой выбор отсутствует.",
"enum": [
"PLAIN",
"FLEXIBLE"
],
"type": "string"
}
},
"required": [
"amount",
"category",
"courierOptionId",
"title"
],
"type": "object"
}
],
"description": "если methodType == COURIER"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
},
"pickupOption": {
"allOf": [
{
"properties": {
"address": {
"description": "Адрес в виде строки",
"maxLength": 2048,
"type": "string"
},
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки в точку",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Дополнительное описание",
"maxLength": 2048,
"type": "string"
},
"fromDate": {
"description": "YYYY-MM-DD. Ближайшая возможная дата доставки",
"format": "date",
"type": "string"
},
"location": {
"properties": {
"latitude": {
"format": "float",
"type": "number"
},
"longitude": {
"format": "float",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"phones": {
"description": "Телефоны для связи",
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"pickupPointId": {
"description": "Уникальный id точки самовывоза в системе продавца",
"maxLength": 2048,
"type": "string"
},
"provider": {
"description": "Тип точки вывоза.",
"enum": [
"YANDEX_MARKET",
"BOXBERRY",
"CDEK",
"IN_STORE",
"RUSSIAN_POST",
"PICKPOINT",
"DPD"
],
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"schedule": {
"description": "График работы точки",
"items": {
"properties": {
"fromTime": {
"description": "HH:mm, \"08:00\"",
"type": "string"
},
"label": {
"description": "Например, \"пн-пт\"",
"maxLength": 2048,
"type": "string"
},
"toTime": {
"description": "HH:mm, \"20:00\"",
"type": "string"
}
},
"required": [
"fromTime",
"label",
"toTime"
],
"type": "object"
},
"type": "array"
},
"storagePeriod": {
"description": "Опционально. Срок хранения товара в точке самовывоза в днях",
"format": "int32",
"type": "integer"
},
"title": {
"description": "Название точки самовывоза",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "YYYY-MM-DD. Самая поздняя дата доставки",
"format": "date",
"type": "string"
}
},
"required": [
"address",
"location",
"pickupPointId",
"title"
],
"type": "object"
}
],
"description": "если methodType == PICKUP"
},
"yandexDeliveryOption": {
"allOf": [
{
"properties": {
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"fromDatetime": {
"format": "date-time",
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"title": {
"description": "Название способа доставки. Показывается пользователю в списке вариантов",
"maxLength": 2048,
"type": "string"
},
"toDatetime": {
"format": "date-time",
"type": "string"
},
"yandexDeliveryOptionId": {
"description": "Id предложения Яндекс Доставки",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"category",
"title",
"yandexDeliveryOptionId"
],
"type": "object"
}
],
"description": "если methodType == YANDEX_DELIVERY"
}
},
"required": [
"methodType"
],
"type": "object"
}
],
"description": "Выбранный способ доставки"
},
"updated": {
"description": "Дата и время обновления заказа (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"cart",
"currencyCode"
],
"type": "object"
}
},
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
},
"MerchantRedirectUrls": {
"properties": {
"onAbort": {
"description": "Ссылка для переадресации пользователя в случае отмены процесса оплаты. Отмену оплаты осуществляет пользователь на форме для оплаты.",
"maxLength": 2048,
"type": "string"
},
"onError": {
"description": "Обязательное поле только для онлайн-магазинов. Ссылка для переадресации пользователя в случае возникновения ошибки во время оплаты, или если срок ссылки на оплату истек.",
"maxLength": 2048,
"type": "string"
},
"onSuccess": {
"description": "Обязательное поле только для онлайн-магазинов. Ссылка для переадресации пользователя в случае успешной оплаты.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"onError",
"onSuccess"
],
"type": "object"
},
"MerchantRiskInfo": {
"properties": {
"billingPhone": {
"description": "**DEPRECATED** Номер телефона клиента.<br/>*Cледует использовать одноименное поле на уровень выше.*",
"maxLength": 2048,
"type": "string"
},
"deviceId": {
"description": "Идентификатор устройства клиента (device_id/gaid/idfa/ifv)",
"maxLength": 2048,
"type": "string"
},
"shippingAddress": {
"description": "Адрес доставки",
"maxLength": 2048,
"type": "string"
},
"shippingPhone": {
"description": "Номер телефона получателя (пример +71234567890)",
"maxLength": 2048,
"type": "string"
},
"shippingType": {
"description": "Способ получения заказа",
"enum": [
"COURIER",
"PICKUP",
null
],
"type": "string"
}
},
"type": "object"
},
"Operation": {
"properties": {
"amount": {
"description": "Сумма операции в фиатной валюте",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Дата и время создания операции (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Идентификатор операции на стороне продавца",
"maxLength": 2048,
"type": "string"
},
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"operationType": {
"enum": [
"AUTHORIZE",
"BIND_CARD",
"REFUND",
"CAPTURE",
"VOID",
"RECURRING",
"PREPAYMENT",
"SUBMIT"
],
"type": "string"
},
"orderId": {
"maxLength": 2048,
"type": "string"
},
"params": {
"type": "object"
},
"pointsAmount": {
"description": "Сумма операции в баллах Плюса",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Причина ошибки",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления операции (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"OperationResponseData": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Сумма операции в фиатной валюте",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Дата и время создания операции (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Идентификатор операции на стороне продавца",
"maxLength": 2048,
"type": "string"
},
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"operationType": {
"enum": [
"AUTHORIZE",
"BIND_CARD",
"REFUND",
"CAPTURE",
"VOID",
"RECURRING",
"PREPAYMENT",
"SUBMIT"
],
"type": "string"
},
"orderId": {
"maxLength": 2048,
"type": "string"
},
"params": {
"type": "object"
},
"pointsAmount": {
"description": "Сумма операции в баллах Плюса",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Причина ошибки",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления операции (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
}
},
"type": "object"
},
"OrderExtensions": {
"properties": {
"billingReport": {
"allOf": [
{
"properties": {
"branchId": {
"default": null,
"description": "Обязательное поле только для офлайн-магазинов. Идентификатор точки продаж",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"default": null,
"description": "Обязательное поле только для офлайн-магазинов. Идентификатор менеджера",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
}
],
"description": "Информация о месте и авторе оформления заказа."
},
"qrData": {
"allOf": [
{
"properties": {
"token": {
"description": "QR токен",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
}
],
"description": "Дополнительные параметры для отправки ссылки на оплату с использованием QR"
},
"smsOffer": {
"allOf": [
{
"properties": {
"phone": {
"description": "Номер телефона клиента (пример `+71234567890`) для СМС-информирования. Только для merchantId офлайн-магазина.",
"maxLength": 2048,
"pattern": "^\\+\\d+$",
"type": "string"
}
},
"required": [
"phone"
],
"type": "object"
}
],
"description": "Дополнительные параметры для отправки ссылки на оплату с использованием SMS.\n\nОбязательное поле только для офлайн-магазинов."
}
},
"type": "object"
},
"OrderResponseData": {
"properties": {
"delivery": {
"properties": {
"actualPrice": {
"description": "Цена доставки для продавца",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Дата и время создания доставки (ISO 8601)",
"format": "date-time",
"type": "string"
},
"price": {
"description": "Цена доставки для покупателя",
"example": "123.45",
"format": "double",
"type": "string"
},
"status": {
"default": "NEW",
"description": "Статус доставки",
"enum": [
"NEW",
"ESTIMATING",
"EXPIRED",
"READY_FOR_APPROVAL",
"COLLECTING",
"PREPARING",
"DELIVERING",
"DELIVERED",
"RETURNING",
"RETURNED",
"FAILED",
"CANCELLED"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления доставки (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"price"
],
"type": "object"
},
"operations": {
"items": {
"properties": {
"amount": {
"description": "Сумма операции в фиатной валюте",
"example": "123.45",
"format": "double",
"type": "string"
},
"approvalCode": {
"description": "Код подтверждения транзакции от процессингового центра.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "Дата и время создания операции (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Идентификатор операции на стороне продавца",
"maxLength": 2048,
"type": "string"
},
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"operationType": {
"enum": [
"AUTHORIZE",
"BIND_CARD",
"REFUND",
"CAPTURE",
"VOID",
"RECURRING",
"PREPAYMENT",
"SUBMIT"
],
"type": "string"
},
"orderId": {
"maxLength": 2048,
"type": "string"
},
"params": {
"type": "object"
},
"reason": {
"description": "Причина ошибки",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления операции (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"type": "array"
},
"order": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Внутренний идентификатор корзины Яндекс Пэй.\n\nБэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса `/order/create`. Если бэкенд магазина получает повторный запрос `/order/create`, то необходимо вернуть уже созданный номер заказа. На одну корзину (`cartId`) бэкенд магазина может создать не больше одного заказа (`orderId`).",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Купоны, применённые к корзине",
"items": {
"properties": {
"description": {
"description": "Описание. Например, \"Скидка 3%\"",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Код купона",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Скидки, применённые к корзине",
"items": {
"properties": {
"amount": {
"description": "Сумма скидки",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Текстовое описание",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Идентификатор скидки в системе мерчанта",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Переданный продавцом идентификатор корзины",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Позиция корзины",
"items": {
"properties": {
"description": {
"description": "Описание товара",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Цена за единицу товара с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "Промо параметры товара"
},
"finalPrice": {
"description": "Цена за единицу товара с учётом всех скидок на позицию и на корзину",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Размеры и вес товара. Обязательно для товара типа `PHYSICAL`"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Максимально доступное количество товара",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Количество товара в заказе",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Количество товара в заказе"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
],
"description": "Данные для формирования чека"
},
"subtotal": {
"description": "Суммарная цена за позицию без учета скидок",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Наименование товара",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Суммарная цена за позицию с учётом скидок на позицию",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Тип товара. Важен для интеграции с доставками",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Полная цена за единицу товара без учетка скидки",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Высота, в метрах",
"format": "float",
"type": "number"
},
"length": {
"description": "Длина, в метрах",
"format": "float",
"type": "number"
},
"weight": {
"description": "Вес, в килограммах",
"format": "float",
"type": "number"
},
"width": {
"description": "Ширина, в метрах",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Стоимость корзины с учетом всех скидок.",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Количество баллов Плюса\n\nПоле только для чтения. Переданные значения будут проигнорированы.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Итоговая стоимость корзины, которая пойдет в оплату"
}
},
"required": [
"items"
],
"type": "object"
}
],
"description": "Корзина"
},
"created": {
"description": "Дата и время создания заказа (ISO 8601)",
"format": "date-time",
"type": "string"
},
"currencyCode": {
"description": "Трехбуквенный код валюты заказа (ISO 4217)",
"enum": [
"RUB"
],
"maxLength": 2048,
"type": "string"
},
"isPrepayment": {
"default": false,
"description": "Флаг, идет ли заказ по флоу \"отложенной оплаты\"",
"type": "boolean"
},
"merchantId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Произвольные данные, переданные при инициализации кнопки",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Полная стоимость заказа к оплате с учётом возвратов, доставки, скидок и промокодов",
"example": "123.45",
"format": "double",
"type": "string"
},
"orderId": {
"description": "Id существующего заказа на стороне продавца, переданный при инициализации кнопки",
"maxLength": 2048,
"type": "string"
},
"paymentMethod": {
"allOf": [
{
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Платежная система",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"CARD",
"SPLIT",
"SBP",
"SPLIT_SBP",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
}
],
"description": "Выбранный способ оплаты"
},
"paymentStatus": {
"enum": [
"PENDING",
"AUTHORIZED",
"CAPTURED",
"VOIDED",
"REFUNDED",
"CONFIRMED",
"PARTIALLY_REFUNDED",
"FAILED",
null
],
"type": "string",
"x-enumDescriptions": {
"AUTHORIZED": "Платеж за заказ авторизован. Средства заблокированы на счету плательщика",
"CAPTURED": "Заказ успешно оплачен. Средства списаны со счета плательщика",
"CONFIRMED": "Заказ успешно оформлен",
"FAILED": "Заказ не был успешно оплачен",
"PARTIALLY_REFUNDED": "Совершён частичный возврат средств за заказ",
"PENDING": "Ожидается оплата",
"REFUNDED": "Совершён возврат средств за заказ",
"VOIDED": "Оплата отменена (voided). Списание средств не производилось"
}
},
"paymentUrl": {
"description": "Ссылка на оплату заказа",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "причина (применимо для статусов VOIDED/FAILED)",
"maxLength": 2048,
"type": "string"
},
"shippingMethod": {
"allOf": [
{
"properties": {
"courierOption": {
"allOf": [
{
"properties": {
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"courierOptionId": {
"description": "id выбранного варианта доставки в системе продавца",
"maxLength": 2048,
"type": "string"
},
"customerChoice": {
"allOf": [
{
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"allOf": [
{
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
]
}
},
"required": [
"date"
],
"type": "object"
}
],
"description": "Выбранные пользователем дата и интервал. Только для `type: FLEXIBLE`"
},
"fromDate": {
"description": "Ближайшая дата доставки для `type: PLAIN`. Начало интервала выбора даты доставки для `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"fromTime": {
"description": "Начало интервала времени доставки. Только для `type: PLAIN`",
"type": "string"
},
"provider": {
"description": "Тип службы доставки.",
"enum": [
"BOXBERRY",
"CDEK",
"RUSSIAN_POST",
"EMS",
"COURIER",
"DHL",
"EXPRESS_DELIVERY",
"FIVEPOST",
"OZON_ROCKET",
"DPD",
"SBER_LOGISTICS",
"PEK",
"PICKPOINT",
"KCE",
"PONY_EXPRESS",
"YANDEX_DELIVERY",
null
],
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"timeIntervals": {
"allOf": [
{
"properties": {
"grid": {
"allOf": [
{
"properties": {
"duration": {
"description": "Продолжительность каждого интервала",
"type": "string"
},
"end": {
"description": "Максимальное время начала самого последнего интервала",
"type": "string"
},
"start": {
"description": "Время начала самого первого интервала",
"type": "string"
},
"step": {
"description": "Разница во времени между началами двух соседних интервалов",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
}
],
"description": "Кодирует интервалы в виде сетки. Используйте этот формат, если необходимо задать больше 20 интервалов доставки.\nПример: `{\"start\": \"09:00\", \"end\": \"21:00\", \"duration\": \"00:20\", \"step\": \"01:00\"}` трактуется как набор интервалов: `[{\"start\": \"09:00\", \"end\": \"09:20\"}, {\"start\": \"10:00\", \"end\": \"10:20\"}, ..., {\"start\": \"20:00\", \"end\": \"20:20\"}]`"
},
"type": {
"description": "Если указан тип `GRID`, то необходимо задать поле `grid`. Если указан тип `VALUES`, то необходимо задать поле `values`",
"enum": [
"GRID",
"VALUES"
],
"type": "string"
},
"values": {
"description": "Задаёт список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 20",
"items": {
"properties": {
"end": {
"description": "Время конца интервала",
"type": "string"
},
"start": {
"description": "Время начала интервала",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "Кодирует интервалы времени доставки, доступные для выбора. Только для `type: FLEXIBLE`"
},
"title": {
"description": "Название способа доставки. Показывается пользователю в списке вариантов",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "Самая поздняя дата доставки для `type: PLAIN`. Конец интервала выбора даты доставки для `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"toTime": {
"description": "Конец интервала времени доставки. Только для `type: PLAIN`",
"type": "string"
},
"type": {
"default": "PLAIN",
"description": "Тип опции.\nДля `FLEXIBLE` вариантов доставки пользователю дается возможность выбрать желаемые дату и интервал:\n- дата доставки выбирается покупателем в отрезке `[fromDate, toDate]`\n- чтобы предоставить пользователю выбор интервала в течении дня, заполните `timeIntervals`\nДля `PLAIN` вариантов такой выбор отсутствует.",
"enum": [
"PLAIN",
"FLEXIBLE"
],
"type": "string"
}
},
"required": [
"amount",
"category",
"courierOptionId",
"title"
],
"type": "object"
}
],
"description": "если methodType == COURIER"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
},
"pickupOption": {
"allOf": [
{
"properties": {
"address": {
"description": "Адрес в виде строки",
"maxLength": 2048,
"type": "string"
},
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки в точку",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Дополнительное описание",
"maxLength": 2048,
"type": "string"
},
"fromDate": {
"description": "YYYY-MM-DD. Ближайшая возможная дата доставки",
"format": "date",
"type": "string"
},
"location": {
"properties": {
"latitude": {
"format": "float",
"type": "number"
},
"longitude": {
"format": "float",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"phones": {
"description": "Телефоны для связи",
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"pickupPointId": {
"description": "Уникальный id точки самовывоза в системе продавца",
"maxLength": 2048,
"type": "string"
},
"provider": {
"description": "Тип точки вывоза.",
"enum": [
"YANDEX_MARKET",
"BOXBERRY",
"CDEK",
"IN_STORE",
"RUSSIAN_POST",
"PICKPOINT",
"DPD"
],
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"schedule": {
"description": "График работы точки",
"items": {
"properties": {
"fromTime": {
"description": "HH:mm, \"08:00\"",
"type": "string"
},
"label": {
"description": "Например, \"пн-пт\"",
"maxLength": 2048,
"type": "string"
},
"toTime": {
"description": "HH:mm, \"20:00\"",
"type": "string"
}
},
"required": [
"fromTime",
"label",
"toTime"
],
"type": "object"
},
"type": "array"
},
"storagePeriod": {
"description": "Опционально. Срок хранения товара в точке самовывоза в днях",
"format": "int32",
"type": "integer"
},
"title": {
"description": "Название точки самовывоза",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "YYYY-MM-DD. Самая поздняя дата доставки",
"format": "date",
"type": "string"
}
},
"required": [
"address",
"location",
"pickupPointId",
"title"
],
"type": "object"
}
],
"description": "если methodType == PICKUP"
},
"yandexDeliveryOption": {
"allOf": [
{
"properties": {
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"fromDatetime": {
"format": "date-time",
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"title": {
"description": "Название способа доставки. Показывается пользователю в списке вариантов",
"maxLength": 2048,
"type": "string"
},
"toDatetime": {
"format": "date-time",
"type": "string"
},
"yandexDeliveryOptionId": {
"description": "Id предложения Яндекс Доставки",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"category",
"title",
"yandexDeliveryOptionId"
],
"type": "object"
}
],
"description": "если methodType == YANDEX_DELIVERY"
}
},
"required": [
"methodType"
],
"type": "object"
}
],
"description": "Выбранный способ доставки"
},
"updated": {
"description": "Дата и время обновления заказа (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"cart",
"currencyCode"
],
"type": "object"
}
},
"type": "object"
},
"OrderResponseOperation": {
"properties": {
"amount": {
"description": "Сумма операции в фиатной валюте",
"example": "123.45",
"format": "double",
"type": "string"
},
"approvalCode": {
"description": "Код подтверждения транзакции от процессингового центра.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "Дата и время создания операции (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Идентификатор операции на стороне продавца",
"maxLength": 2048,
"type": "string"
},
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"operationType": {
"enum": [
"AUTHORIZE",
"BIND_CARD",
"REFUND",
"CAPTURE",
"VOID",
"RECURRING",
"PREPAYMENT",
"SUBMIT"
],
"type": "string"
},
"orderId": {
"maxLength": 2048,
"type": "string"
},
"params": {
"type": "object"
},
"reason": {
"description": "Причина ошибки",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Дата и время обновления операции (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"PaymentMethod": {
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Платежная система",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"CARD",
"SPLIT",
"SBP",
"SPLIT_SBP",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
},
"PaymentsOperator": {
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PickupOption": {
"properties": {
"address": {
"description": "Адрес в виде строки",
"maxLength": 2048,
"type": "string"
},
"allowedPaymentMethods": {
"description": "Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Стоимость доставки в точку",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Дополнительное описание",
"maxLength": 2048,
"type": "string"
},
"fromDate": {
"description": "YYYY-MM-DD. Ближайшая возможная дата доставки",
"format": "date",
"type": "string"
},
"location": {
"properties": {
"latitude": {
"format": "float",
"type": "number"
},
"longitude": {
"format": "float",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"phones": {
"description": "Телефоны для связи",
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"pickupPointId": {
"description": "Уникальный id точки самовывоза в системе продавца",
"maxLength": 2048,
"type": "string"
},
"provider": {
"description": "Тип точки вывоза.",
"enum": [
"YANDEX_MARKET",
"BOXBERRY",
"CDEK",
"IN_STORE",
"RUSSIAN_POST",
"PICKPOINT",
"DPD"
],
"type": "string"
},
"receipt": {
"allOf": [
{
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Признак агента по предмету расчёта. См. [значения](https://pay.yandex.ru/ru/docs/custom/fns#agent-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"operation": {
"maxLength": 2048,
"type": "string"
},
"paymentsOperator": {
"allOf": [
{
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"transferOperator": {
"allOf": [
{
"properties": {
"address": {
"maxLength": 2048,
"type": "string"
},
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
}
},
"required": [
"agentType"
],
"type": "object"
}
]
},
"excise": {
"description": "Не должно содержать больше двух знаков после запятой.\nНапример: 1.12, 5.1, 10, 11.00 .",
"example": "123.45",
"format": "double",
"type": "string"
},
"markQuantity": {
"allOf": [
{
"properties": {
"denominator": {
"format": "int32",
"type": "integer"
},
"numerator": {
"format": "int32",
"type": "integer"
}
},
"required": [
"denominator",
"numerator"
],
"type": "object"
}
]
},
"measure": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#measure-code)",
"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
],
"type": "integer"
},
"paymentMethodType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#payment-subject-type)",
"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
],
"type": "integer"
},
"productCode": {
"description": "Код товара (base64 кодированный массив от 1 до 32 байт)",
"format": "base64",
"type": "string"
},
"supplier": {
"allOf": [
{
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"tax": {
"description": "Описание значений: [Ссылка](https://pay.yandex.ru/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"title": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"tax"
],
"type": "object"
}
]
},
"schedule": {
"description": "График работы точки",
"items": {
"properties": {
"fromTime": {
"description": "HH:mm, \"08:00\"",
"type": "string"
},
"label": {
"description": "Например, \"пн-пт\"",
"maxLength": 2048,
"type": "string"
},
"toTime": {
"description": "HH:mm, \"20:00\"",
"type": "string"
}
},
"required": [
"fromTime",
"label",
"toTime"
],
"type": "object"
},
"type": "array"
},
"storagePeriod": {
"description": "Опционально. Срок хранения товара в точке самовывоза в днях",
"format": "int32",
"type": "integer"
},
"title": {
"description": "Название точки самовывоза",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "YYYY-MM-DD. Самая поздняя дата доставки",
"format": "date",
"type": "string"
}
},
"required": [
"address",
"location",
"pickupPointId",
"title"
],
"type": "object"
},
"PickupSchedule": {
"properties": {
"fromTime": {
"description": "HH:mm, \"08:00\"",
"type": "string"
},
"label": {
"description": "Например, \"пн-пт\"",
"maxLength": 2048,
"type": "string"
},
"toTime": {
"description": "HH:mm, \"20:00\"",