/v1/subscriptions/recur
Запрос для очередного списания по подписке.
Запрос используется для безакцептного списания денежных средств с привязанного к подписке счета или карты. Для списания нужно передать номер заказа, корзину, сумму списания, и номер стартового заказа, который был использован при создании подписки.
Request
POST
https://pay.yandex.uz/api/merchant/v1/subscriptions/recur
Production
POST
https://sandbox.pay.yandex.uz/api/merchant/v1/subscriptions/recur
Sandbox
Body
application/json
{
"amount": "123.45",
"cart": {
"externalId": "string",
"items": [
{
"description": "string",
"discountedUnitPrice": "123.45",
"features": {
"tariffModifier": "VERY_LOW"
},
"productId": "string",
"quantity": {
"available": "123.45",
"count": "123.45"
},
"skuId": "string",
"subtotal": "123.45",
"title": "string",
"total": "123.45",
"unitPrice": "123.45"
}
],
"total": {
"amount": "123.45"
}
},
"currencyCode": "RUB",
"metadata": "string",
"orderId": "string",
"parentOrderId": "string",
"purpose": "string"
}
|
Name |
Description |
|
amount* |
Type: string<double> Сумма списания Example: |
|
cart* |
Type: RenderedCart1 Корзина |
|
currencyCode* |
Type: string Трехбуквенный код валюты заказа (ISO 4217) Max length: Enum: |
|
orderId* |
Type: string Идентификатор заказа на стороне продавца (должен быть уникальным) Max length: |
|
parentOrderId* |
Type: string Идентификатор стартового заказа Max length: |
|
metadata |
Type: string Произвольные данные по заказу для внутреннего использования Max length: |
|
purpose |
Type: string Назначение платежа Max length: |
RenderedCart1
|
Name |
Description |
|
items* |
Type: RenderedCartItem1[] Корзина товаров, которую оплачивает покупатель. |
|
total* |
Type: CartTotal Итоговая информация о стоимости заказа. |
|
externalId |
Type: string Переданный продавцом идентификатор корзины Max length: |
RenderedCartItem1
|
Name |
Description |
|
productId* |
Type: string Id товара в системе продавца. В параметрах запроса каждый идентификатор товара Max length: |
|
quantity* |
Type: ItemQuantity Количество товара в заказе |
|
title* |
Type: string Наименование товара Max length: |
|
total* |
Type: string<double> Суммарная цена за позицию с учётом скидок на позицию Example: |
|
description |
Type: string Описание товара Max length: |
|
discountedUnitPrice |
Type: string<double> Цена за единицу товара с учётом скидок на позицию Example: |
|
features |
Type: CartItemFeatures1 Промо параметры товара |
|
skuId |
Type: string Уникальный id, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа. Max length: |
|
subtotal |
Type: string<double> Суммарная цена за позицию без учета скидок Example: |
|
unitPrice |
Type: string<double> Полная цена за единицу товара без учетка скидки Example: |
CartTotal
|
Name |
Description |
|
amount* |
Type: string<double> Стоимость корзины с учетом всех скидок. Example: |
ItemQuantity
|
Name |
Description |
|
count* |
Type: string<double> Количество товара в заказе Example: |
|
available |
Type: string<double> Максимально доступное количество товара Example: |
CartItemFeatures1
|
Name |
Description |
|
tariffModifier |
Type: string Модификатор тарифа для расчета комиссии. Определяет, какой тариф будет применяться при расчете комиссии за обработку позиции в корзине. Enum: |
Responses
200 OK
Body
application/json
{
"code": 200,
"data": {
"operationId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b"
},
"status": "success"
}
|
Name |
Description |
|
code |
Type: number Default: |
|
data |
|
|
status |
Type: string Default: Enum: |
RecurSubscriptionResponseData
|
Name |
Description |
|
operationId* |
Type: string<uuid> Max length: |
No longer supported, please use an alternative and newer version.