/v1/subscriptions

Этот раздел доступен по прямой ссылке

Чтобы узнать, как происходит аутентификация и какие HTTP-заголовки нужно передавать в запросах API Яндекс Пэй, читайте в разделе Аутентификация.

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

Используется в рекуррентных и рекарринговых платежах.

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

Request

POST

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

Production

POST

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

Sandbox

Body

application/json
{
  "cart": {
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "features": null,
        "productId": "example",
        "quantity": null,
        "receipt": null,
        "skuId": "example",
        "subtotal": "123.45",
        "title": "example",
        "total": "123.45",
        "unitPrice": "123.45"
      }
    ],
    "total": {
      "amount": "123.45",
      "externalAmount": "123.45"
    }
  },
  "currencyCode": "RUB",
  "futureWriteOffAmount": "123.45",
  "intervalCount": 6,
  "intervalUnit": "SECOND",
  "isBinding": false,
  "metadata": "example",
  "orderId": "example",
  "orderSource": "null",
  "purpose": "example",
  "redirectUrls": {
    "onAbort": "example",
    "onError": "example",
    "onSuccess": "example"
  },
  "title": "example",
  "trialCount": 0,
  "trialEndAt": "2025-01-01T00:00:00Z",
  "trialUnit": "SECOND",
  "ttl": 1800
}

Name

Description

currencyCode

Type: string

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

Enum: RUB, UZS

Max length: 2048

orderId

Type: string

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

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

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

Max length: 2048

Example: example

cart
All of 1 type

  • Type: RenderedCart1

    Примечание

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

    Example
    {
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "tariffModifier": "VERY_LOW"
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45",
    "externalAmount": "123.45"
  }
}

Корзина

Example
{
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": null,
      "productId": "example",
      "quantity": null,
      "receipt": null,
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45",
    "externalAmount": "123.45"
  }
}

futureWriteOffAmount

Type: string<double>

Сумма, которую будет списана в будущем

Example: 123.45

intervalCount

Type: integer

Количество периодов подписки в единицах времени, указанных в intervalUnit.

Например, для подписки в 6 месяцев укажите: intervalUnit: 'MONTH', intervalCount: 6.

Обязательно, если не указан параметр isBinding=True.

intervalUnit

Type: string

Единица времени, в которой будет периодичность подписки.

Обязательно, если не указан параметр isBinding=True.

Enum: SECOND, DAY, WEEK, MONTH, YEAR, null

Example: SECOND

isBinding

Type: boolean

Позволяет привязать карту пользователя без сформированной корзины товаров

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

Корзину и периодичность подписки в данном сценарии передавать не нужно.

Default: false

metadata

Type: string

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

Max length: 2048

Example: example

orderSource

Type: string

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

Возможные значения:

  • WEBSITE — кнопка размещена на сайте. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя на сайте;
  • APP — кнопка размещена в мобильном приложении. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя в приложении;
  • CRM — ссылка на оплату сформирована менеджером в CRM или другой админке;
  • CASH_REGISTER — ссылка на оплату сформирована для отображения на оффлайн-кассе;
  • CMS_PLUGIN — ссылка на оплату сформирована в плагине для CMS;
  • TV — ссылка на оплату сформирована для отображения на ТВ-платформе.

Default: null

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

purpose

Type: string

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

Max length: 1000

Example: example

redirectUrls
All of 1 type

  • Type: MerchantRedirectUrls

    Примечание

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

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

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

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

title

Type: string

Название подписки

Max length: 30

Example: example

trialCount

Type: integer

Количество периодов триального периода, например "7 дней"

trialEndAt

Type: string<date-time>

Дата окончания пробного периода. Взаимоисключающее с полями trial_unit + trial_count

Example: 2025-01-01T00:00:00Z

trialUnit

Type: string

Единица времени в которой будет периодичность триального периода

Enum: SECOND, DAY, WEEK, MONTH, YEAR, null

Example: SECOND

ttl

Type: integer

Время жизни заказа (в секундах)

120 <= ttl <= 604800

Default: 1800

CartItemFeatures1

Name

Description

tariffModifier

Type: string

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

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

Example: VERY_LOW
Example
{
  "tariffModifier": "VERY_LOW"
}

ItemQuantity

Name

Description

count

Type: string<double>

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

Example: 123.45

available

Type: string<double>

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

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

PaymentsOperator

Name

Description

phones

Type: string[]

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

TransferOperator

Name

Description

address

Type: string

Max length: 2048

Example: example

inn

Type: string

Max length: 2048

Example: example

name

Type: string

Max length: 2048

Example: example

phones

Type: string[]

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

Agent

Name

Description

agentType

Type: integer

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

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

operation

Type: string

Max length: 2048

Example: example

paymentsOperator

Type: PaymentsOperator

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

phones

Type: string[]

Example
[
  "example"
]

transferOperator

Type: TransferOperator

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

MarkQuantity

Name

Description

denominator

Type: integer

numerator

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

Supplier

Name

Description

inn

Type: string

Max length: 2048

Example: example

name

Type: string

Max length: 2048

Example: example

phones

Type: string[]

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

ItemReceipt

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

Name

Description

tax

Type: integer

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

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

agent

Type: Agent

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

excise

Type: string<double>

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

Example: 123.45

markQuantity

Type: MarkQuantity

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

measure

Type: integer

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

Enum: 0, 10, 11, 12, 20, 21, 22, 30, 31, 32, 40, 41, 42, 50, 51, 70, 71, 72, 73, 80, 81, 82, 83, 255, null

paymentMethodType

Type: integer

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

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

paymentSubjectType

Type: integer

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

Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, null

productCode

Type: string<base64>

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

Example: example

supplier

Type: Supplier

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

title

Type: string

Max length: 2048

Example: example
Example
{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

RenderedCartItem1

Name

Description

productId

Type: string

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

Max length: 2048

Example: example

quantity
All of 1 type

  • Type: ItemQuantity

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

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

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

title

Type: string

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

Max length: 2048

Example: example

total

Type: string<double>

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

Важно

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

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

Пример

Правильно:

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

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

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

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

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

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

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

Example: 123.45

description

Type: string

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

Max length: 2048

Example: example

discountedUnitPrice

Type: string<double>

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

Example: 123.45

features
All of 1 type

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

Example
{
  "tariffModifier": "VERY_LOW"
}

receipt
All of 1 type

  • Type: ItemReceipt

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

    Example
    {
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

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

Example
{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

skuId

Type: string

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

Max length: 2048

Example: example

subtotal

Type: string<double>

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

Example: 123.45

unitPrice

Type: string<double>

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

Example: 123.45
Example
{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "tariffModifier": "VERY_LOW"
  },
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

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

Example: 123.45

externalAmount

Type: string<double>

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

При использовании в /orders/{order_id}/capture не должна превышать значение externalAmount, переданное в /orders при создании заказа.

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

RenderedCart1

Примечание

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

Name

Description

items

Type: RenderedCartItem1[]

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

Example
[
  {
    "description": "example",
    "discountedUnitPrice": "123.45",
    "features": {
      "tariffModifier": "VERY_LOW"
    },
    "productId": "example",
    "quantity": {
      "available": "123.45",
      "count": "123.45"
    },
    "receipt": {
      "agent": {
        "agentType": 1,
        "operation": "example",
        "paymentsOperator": {},
        "phones": [
          null
        ],
        "transferOperator": {}
      },
      "excise": "123.45",
      "markQuantity": {
        "denominator": 0,
        "numerator": 0
      },
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": {
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      },
      "tax": 1,
      "title": "example"
    },
    "skuId": "example",
    "subtotal": "123.45",
    "title": "example",
    "total": "123.45",
    "unitPrice": "123.45"
  }
]

total
All of 1 type

  • Type: CartTotal

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

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

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

externalId

Type: string

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

Max length: 2048

Example: example
Example
{
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "tariffModifier": "VERY_LOW"
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45",
    "externalAmount": "123.45"
  }
}

MerchantRedirectUrls

Примечание

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

Name

Description

onError

Type: string

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

Max length: 2048

Example: example

onSuccess

Type: string

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

Max length: 2048

Example: example

onAbort

Type: string

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

Max length: 2048

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

Responses

200 OK

Body

application/json
{
  "code": 200,
  "data": {
    "paymentUrl": "example",
    "subscriptionId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "status": "success"
}

Name

Description

data

Type: CreateSubscriptionResponseData

Example
{
  "paymentUrl": "example",
  "subscriptionId": "123e4567-e89b-12d3-a456-426614174000"
}

code

Type: unknown

Default: 200

status

Type: string

Default: success

Enum: success, fail

RenderedCartItem1

Name

Description

productId

Type: string

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

Max length: 2048

Example: example

quantity
All of 1 type

  • Type: ItemQuantity

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

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

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

title

Type: string

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

Max length: 2048

Example: example

total

Type: string<double>

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

Важно

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

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

Пример

Правильно:

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

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

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

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

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

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

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

Example: 123.45

description

Type: string

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

Max length: 2048

Example: example

discountedUnitPrice

Type: string<double>

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

Example: 123.45

features
All of 1 type

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

Example
{
  "tariffModifier": "VERY_LOW"
}

pointsAmount

Type: string<double>

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

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

Example: 123.45

receipt
All of 1 type

  • Type: ItemReceipt

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

    Example
    {
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

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

Example
{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

skuId

Type: string

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

Max length: 2048

Example: example

subtotal

Type: string<double>

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

Example: 123.45

unitPrice

Type: string<double>

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

Example: 123.45
Example
{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "tariffModifier": "VERY_LOW"
  },
  "pointsAmount": "123.45",
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

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

Example: 123.45

externalAmount

Type: string<double>

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

При использовании в /orders/{order_id}/capture не должна превышать значение externalAmount, переданное в /orders при создании заказа.

Example: 123.45

pointsAmount

Type: string<double>

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

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

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

RenderedCart1

Примечание

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

Name

Description

items

Type: RenderedCartItem1[]

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

Example
[
  {
    "description": "example",
    "discountedUnitPrice": "123.45",
    "features": {
      "tariffModifier": "VERY_LOW"
    },
    "pointsAmount": "123.45",
    "productId": "example",
    "quantity": {
      "available": "123.45",
      "count": "123.45"
    },
    "receipt": {
      "agent": {
        "agentType": 1,
        "operation": "example",
        "paymentsOperator": {},
        "phones": [
          null
        ],
        "transferOperator": {}
      },
      "excise": "123.45",
      "markQuantity": {
        "denominator": 0,
        "numerator": 0
      },
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": {
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      },
      "tax": 1,
      "title": "example"
    },
    "skuId": "example",
    "subtotal": "123.45",
    "title": "example",
    "total": "123.45",
    "unitPrice": "123.45"
  }
]

total
All of 1 type

  • Type: CartTotal

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

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

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

externalId

Type: string

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

Max length: 2048

Example: example
Example
{
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "tariffModifier": "VERY_LOW"
      },
      "pointsAmount": "123.45",
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45",
    "externalAmount": "123.45",
    "pointsAmount": "123.45"
  }
}

CreateSubscriptionResponseData

Name

Description

paymentUrl

Type: string

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

Max length: 2048

Example: example

subscriptionId

Type: string<uuid>

Идентификатор подписки

Max length: 2048

Example: 123e4567-e89b-12d3-a456-426614174000
Example
{
  "paymentUrl": "example",
  "subscriptionId": "123e4567-e89b-12d3-a456-426614174000"
}