Yandex Pay API
version: 1.0.0
Headers
Pass the following HTTP headers in your requests:
- X-Request-Id:
- X-Request-Timeout:
- X-Request-Attempt: <attempt number (0 — first attempt, 1, 2, etc. — retries)>
X-Request-Id is needed to debug requests and ensure idempotency of write requests.
That's why the same X-Request-Id value must be preserved across all retries when receiving
HTTP 5xx errors or 429 responses.
X-Request-Timeout is required for deadline propagation
during request processing within the system.
Avoid timeout values that are less than one second. The maximum timeout value is 10 seconds.
X-Request-Attempt is helpful when running general diagnostics.
Authorizing merchant requests
To use the API, you must obtain an authentication API key.
Pass the token in each request in the HTTP Authorization header.
Key management is available in the Yandex Split console.
In the sandbox environment, the API key is equal to the Merchant ID value.
--header 'Authorization: Api-Key <key value>'
If the token passed in the request is invalid or missing,
the server returns the 401 Unauthorized HTTP status.
Sections
Specification
Open API
{
"components": {
"schemas": {
"Agent": {
"properties": {
"agentType": {
"description": "Agent type by taxable object. See [values](https://pay.yandex.uz/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"
},
"BaseMerchantApiOrder": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "List of cart items",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"finalPrice": {
"description": "Unit price including all item-level and cart-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Total cart cost that the customer is to pay"
}
},
"required": [
"items"
],
"type": "object"
}
],
"description": "Cart"
},
"coolingPeriodExpiresAt": {
"description": "Cooling-off period end date and time (ISO 8601)",
"format": "date-time",
"type": "string"
},
"created": {
"description": "Date and time when the order was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"isPrepayment": {
"default": false,
"description": "Flag indicating whether to process the order using the \"deferred payment\" flow.\n\nIf set to `true`, deferred payment is enabled for the order.",
"type": "boolean"
},
"merchantId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Arbitrary data transmitted at button initialization",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Total cost of the order to be paid, including refunds, delivery costs, discounts, and promo codes",
"example": "123.45",
"format": "double",
"type": "string"
},
"orderId": {
"description": "Merchant-side order ID that was passed in the [/orders](../order/merchant_v1_orders-post.md) request.",
"maxLength": 2048,
"type": "string"
},
"paymentMethod": {
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Payment system",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"SPLIT"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
},
"paymentStatus": {
"description": "For more information, see [Operation statuses](../../../../payments/statuses).",
"enum": [
"PENDING",
"AUTHORIZED",
"CAPTURED",
"VOIDED",
"REFUNDED",
"CONFIRMED",
"PARTIALLY_REFUNDED",
"FAILED",
null
],
"type": "string",
"x-enumDescriptions": {
"AUTHORIZED": "Платеж за заказ авторизован. Средства заблокированы на счету плательщика",
"CAPTURED": "Заказ успешно оплачен. Средства списаны со счета плательщика",
"CONFIRMED": "Заказ успешно оформлен",
"FAILED": "Заказ не был успешно оплачен",
"PARTIALLY_REFUNDED": "Совершен частичный возврат средств за заказ",
"PENDING": "Ожидается оплата",
"REFUNDED": "Совершен возврат средств за заказ",
"VOIDED": "Оплата отменена. Списание средств не производилось"
}
},
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "Order cancellation reason. Applicable to the `VOIDED` and `FAILED` statuses.",
"maxLength": 2048,
"type": "string"
},
"updated": {
"description": "Date and time when the order was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"cart",
"currencyCode"
],
"type": "object"
},
"BillingReport": {
"properties": {
"branchId": {
"default": null,
"description": "The field is required for offline stores only. ID of the point of sale",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"default": null,
"description": "The field is required for offline stores only. Manager ID",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
},
"CancelOrderRequest": {
"properties": {
"externalOperationId": {
"description": "Operation ID",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "Cancellation reason",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"CaptureRequest": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Final cart"
},
"externalOperationId": {
"description": "Operation ID",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Amount to be debited. If not specified, the total amount of the passed cart items will be debited",
"example": "123.45",
"format": "double",
"type": "string"
},
"shipping": {
"allOf": [
{
"properties": {
"amount": {
"description": "It shouldn't include more than two decimal digits.\nFor example: 1.12, 5.1, 10, or 11.00.",
"example": "123.45",
"format": "double",
"type": "string"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
}
},
"required": [
"amount",
"methodType"
],
"type": "object"
}
],
"description": "Final delivery method."
}
},
"type": "object"
},
"Cart": {
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "List of cart items",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"finalPrice": {
"description": "Unit price including all item-level and cart-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Total cart cost that the customer is to pay"
}
},
"required": [
"items"
],
"type": "object"
},
"CartItem": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"finalPrice": {
"description": "Unit price including all item-level and cart-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"CartItemFeatures": {
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
},
"CartItemFeatures1": {
"properties": {
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
},
"CartItemWithoutFinalPriceCamelCase": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"CartTotal": {
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
},
"CartWithRequiredTotalWithoutFinalPrice": {
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"required": [
"items",
"total"
],
"type": "object"
},
"CheckSubscriptionUserCardActivated": {
"properties": {
"check_card_active": {
"description": "Allows checking if the card is linked",
"type": "boolean"
}
},
"type": "object"
},
"Coupon": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"CourierOption": {
"properties": {
"allowedPaymentMethods": {
"description": "Individual payment methods for the delivery method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY",
"UNIQR_REUSABLE",
"UNIQR_ONETIME"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Delivery cost",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"courierOptionId": {
"description": "ID of the selected delivery method in the merchant system",
"maxLength": 2048,
"type": "string"
},
"customerChoice": {
"allOf": [
{
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"allOf": [
{
"properties": {
"end": {
"description": "Interval end time",
"type": "string"
},
"start": {
"description": "Interval start time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
]
}
},
"required": [
"date"
],
"type": "object"
}
],
"description": "Date and interval selected by the user. Only for `type: FLEXIBLE`"
},
"fromDate": {
"description": "Closest delivery date for `type: PLAIN`. Start of the interval of the delivery date selection for `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"fromTime": {
"description": "Start of the delivery time interval. Only for `type: PLAIN`",
"type": "string"
},
"provider": {
"description": "Delivery service type.",
"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"
},
"timeIntervals": {
"allOf": [
{
"properties": {
"grid": {
"allOf": [
{
"properties": {
"duration": {
"description": "Duration of each interval",
"type": "string"
},
"end": {
"description": "Maximum start time for the latest interval",
"type": "string"
},
"start": {
"description": "Start time for the very first interval",
"type": "string"
},
"step": {
"description": "Difference in time between the starts of two neighboring intervals",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
}
],
"description": "Encodes the intervals as a grid. Use this format if you want to set more than 20 delivery intervals.\nExample: `{\"start\": \"09:00\", \"end\": \"21:00\", \"duration\": \"00:20\", \"step\": \"01:00\"}` is treated as a set of intervals: `[{\"start\": \"09:00\", \"end\": \"09:20\"}, {\"start\": \"10:00\", \"end\": \"10:20\"}, ..., {\"start\": \"20:00\", \"end\": \"20:20\"}]`"
},
"type": {
"description": "For the `GRID` type, fill in the `grid` field. If the `VALUES` type is specified, set the `values` field.",
"enum": [
"GRID",
"VALUES"
],
"type": "string"
},
"values": {
"description": "Specifies the list of intervals directly. Suitable for a small number of delivery intervals. The maximum recommended number of intervals is 20",
"items": {
"properties": {
"end": {
"description": "Interval end time",
"type": "string"
},
"start": {
"description": "Interval start time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "Codes the intervals of the delivery time available for selection. Only for `type: FLEXIBLE`"
},
"title": {
"description": "Delivery method name. Shown to the user in the option list",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "Latest delivery date for `type: PLAIN`. End of the delivery date selection range for `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"toTime": {
"description": "End of the delivery time interval. Only for `type: PLAIN`",
"type": "string"
},
"type": {
"default": "PLAIN",
"description": "Option type.\nFor `FLEXIBLE` delivery options, the user can select the desired date and interval:\n- The delivery date is selected by the customer within the range `[fromDate, toDate]`\n- To give the user an option to select an interval within a day, fill out `timeIntervals`\nNo such choice is provided for `PLAIN` options.",
"enum": [
"PLAIN",
"FLEXIBLE"
],
"type": "string"
}
},
"required": [
"amount",
"category",
"courierOptionId",
"title"
],
"type": "object"
},
"CreateOrderRequest": {
"properties": {
"availablePaymentMethods": {
"default": null,
"description": "Payment methods that will be available to the customer in the Yandex Split payment form.\n\nPossible values:\n- `[\"SPLIT\"]`: Split only.",
"items": {
"enum": [
"CARD",
"SPLIT"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"billingPhone": {
"description": "Customer phone number.\n\nUsed for simplified authorization and may make Split approval more likely.\n\nRecommended phone number format: `+998123456789` or `998123456789`. The string may contain other characters. However, any characters, except numbers, are ignored.\n\nFor example, values like `998123456789`, `+998123456789`, or `+998 (12) 345-67-89` will be processed as `998123456789`.",
"maxLength": 2048,
"type": "string"
},
"cart": {
"allOf": [
{
"description": "{% note info %}\n\nPass the delivery cost in `items` as a separate product.\n\n{% endnote %}",
"properties": {
"externalId": {
"description": "Cart ID on the merchant side",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "List of cart items",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Final order cost."
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Cart"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"extensions": {
"allOf": [
{
"properties": {
"billingReport": {
"allOf": [
{
"properties": {
"branchId": {
"default": null,
"description": "The field is required for offline stores only. ID of the point of sale",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"default": null,
"description": "The field is required for offline stores only. Manager ID",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
}
],
"description": "Information about where the order was placed and who placed it."
},
"paymentData": {
"allOf": [
{
"properties": {
"saleToken": {
"description": "Unique ID generated by the cash register for each payment transaction",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
}
],
"description": "Additional payment parameters"
},
"qrData": {
"allOf": [
{
"properties": {
"token": {
"description": "QR token",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
}
],
"description": "Additional parameters for sending a link for payment via QR code."
},
"smsOffer": {
"allOf": [
{
"properties": {
"phone": {
"description": "Customer phone number (such as `+998123456789`) for SMS notifications.\nFor offline stores only.",
"maxLength": 2048,
"pattern": "^\\+\\d+$",
"type": "string"
}
},
"required": [
"phone"
],
"type": "object"
}
],
"description": "Additional parameters for sending a link for payment via SMS.\n\nThe field is required for offline stores only."
}
},
"type": "object"
}
],
"default": null,
"description": "Additional parameters for placing an offline order"
},
"isPrepayment": {
"description": "Flag indicating whether to process the order using the \"deferred payment\" flow.\n\nIf set to `true`, deferred payment is enabled for the order.",
"type": "boolean"
},
"metadata": {
"description": "Arbitrary order data for internal use",
"maxLength": 2048,
"type": "string"
},
"orderId": {
"description": "Order ID on the merchant side (it should be unique). Further interaction on the payment request will be carried out using this ID. The ID will also be used at reconciliation",
"maxLength": 2048,
"type": "string"
},
"orderSource": {
"default": null,
"description": "Indicates where order creation was initialized.\n\nUsed for subsequent analysis\n\n---\n\n**WEBSITE**: The button is placed on a website. A payment link is generated after certain user actions (clicking the button) on the website\n\n**APP**: The button is placed in a mobile app. A payment link is generated after certain user actions (tapping the button) in the app\n\n**CRM**: A payment link is generated by a manager in the CRM system or another admin panel\n\n**CASH_REGISTER**: A payment link is generated to be displayed in the offline cash register\n\n**CMS_PLUGIN**: A payment link is generated in the CMS plugin\n\n**TV**: A payment link is generated to be displayed on a TV platform",
"enum": [
"WEBSITE",
"APP",
"CRM",
"CASH_REGISTER",
"CMS_PLUGIN"
],
"type": "string"
},
"preferredPaymentMethod": {
"description": "Preferred payment method.\n\nThe provided method will be automatically selected in the payment form if it does not conflict with the methods specified in `availablePaymentMethods`.",
"enum": [
"FULLPAYMENT",
"SPLIT"
],
"type": "string"
},
"publicConstructor": {
"description": "Constructor of the preselected Split payment plan.\n\n_Available only upon approval_",
"type": "string"
},
"purpose": {
"description": "Purpose of payment",
"maxLength": 1000,
"type": "string"
},
"redirectUrls": {
"allOf": [
{
"properties": {
"onAbort": {
"description": "Link to redirect the user on payment cancellation. Payment can be canceled by the user in the payment form.",
"maxLength": 2048,
"type": "string"
},
"onError": {
"description": "The field is required for online stores only. A link to redirect the user in case of a payment error or TTL expiry for a payment link",
"maxLength": 2048,
"type": "string"
},
"onSuccess": {
"description": "The field is required for online stores only. Link to redirect the user on payment success.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"onError",
"onSuccess"
],
"type": "object"
}
],
"description": "Links for redirecting the user from the payment form. Required for online stores."
},
"risk": {
"allOf": [
{
"properties": {
"billingPhone": {
"description": "**DEPRECATED** Customer phone number.<br/>*Use the field with the same name one level up instead.*",
"maxLength": 2048,
"type": "string"
},
"customerAggregates": {
"allOf": [
{
"properties": {
"amountFirstSuccessfulOrder": {
"description": "Amount of the first successful order",
"example": "123.45",
"format": "double",
"type": "string"
},
"amountLatestSuccessfulOrder": {
"description": "Amount of the last successful order",
"example": "123.45",
"format": "double",
"type": "string"
},
"cookie": {
"description": "Cookies",
"maxLength": 2048,
"type": "string"
},
"daysSinceLastPasswordReset": {
"description": "How many days have passed since the last password reset",
"format": "int32",
"type": "integer"
},
"failedLoginAttemptsOneDay": {
"description": "Number of failed login attempts over the past day",
"format": "int32",
"type": "integer"
},
"failedLoginAttemptsSevenDays": {
"description": "Number of failed login attempts over the past 7 days",
"format": "int32",
"type": "integer"
},
"firstSuccessfulOrderDate": {
"description": "Date of the first successful order in the order history",
"format": "date",
"type": "string"
},
"historicalCookieLogin": {
"description": "Login with saved cookies (user previously paid for an order)",
"type": "boolean"
},
"historicalDeviceLogin": {
"description": "Login from a saved device (user previously paid for an order)",
"type": "boolean"
},
"lastPasswordResetDate": {
"description": "Date of the last password reset",
"format": "date",
"type": "string"
},
"latestSuccessfulOrderLastYearDate": {
"description": "Date of the last successful order over the past year",
"format": "date",
"type": "string"
},
"previousSuccessfulOrdersAtSameAddress": {
"description": "Whether the user has previously completed a successful order at the current address",
"type": "boolean"
},
"redemptionRateLastHalfYear": {
"description": "Buyout percentage over the past 6 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"registrationDate": {
"description": "Date of user registration on the merchant's website",
"format": "date",
"type": "string"
}
},
"type": "object"
}
],
"description": "Aggregate customer data"
},
"deviceId": {
"description": "Customer device ID (device_id/gaid/idfa/ifv)",
"maxLength": 2048,
"type": "string"
},
"isExpressShipping": {
"description": "Express delivery flag",
"type": "boolean"
},
"merchantMcc": {
"description": "Merchant category code (MCC)",
"maxLength": 2048,
"type": "string"
},
"merchantName": {
"description": "Merchant name",
"maxLength": 2048,
"type": "string"
},
"merchantOfflinePosLegalAddress": {
"description": "Offline POS legal address",
"maxLength": 2048,
"type": "string"
},
"merchantTaxRefNumber": {
"description": "Merchant tax ID",
"maxLength": 2048,
"type": "string"
},
"periodCheckAggregates": {
"allOf": [
{
"properties": {
"successfulOrdersCountNineMonths": {
"description": "Number of successful orders over the past 9 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountOneMonth": {
"description": "Number of successful orders over the past month",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountSixMonths": {
"description": "Number of successful orders over the past 6 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountThreeMonths": {
"description": "Number of successful orders over the past 3 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountTwelveMonths": {
"description": "Number of successful orders over the past 12 months",
"format": "int32",
"type": "integer"
},
"totalAmountSuccessfulOrdersNineMonths": {
"description": "Total amount of successful orders over the past 9 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersOneMonth": {
"description": "Total amount of successful orders over the past month",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersSixMonths": {
"description": "Total amount of successful orders over the past 6 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersThreeMonths": {
"description": "Total amount of successful orders over the past 3 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersTwelveMonths": {
"description": "Total amount of successful orders over the past 12 months",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"type": "object"
}
],
"description": "Aggregate data on receipts over different periods"
},
"qrType": {
"description": "QR code type",
"enum": [
"static",
"dynamic",
null
],
"type": "string"
},
"qrcId": {
"description": "QR code ID",
"maxLength": 2048,
"type": "string"
},
"shippingAddress": {
"description": "Delivery address. If the `PICKUP` order delivery method is selected, specify the pickup point address.",
"maxLength": 2048,
"type": "string"
},
"shippingPhone": {
"description": "Recipient phone number (e.g., +998123456789)",
"maxLength": 2048,
"type": "string"
},
"shippingType": {
"description": "Order delivery method",
"enum": [
"COURIER",
"PICKUP",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Additional info specifying which may make Split approval more likely. Fully available for online stores only."
},
"ttl": {
"default": 1800,
"description": "This parameter defines how long the user can use the payment link to access the order payment form.\n\nAfter expiration, the user will see the message: \"Payment time expired\".\n\nIf the user follows the link before expiration, they will be given another 15 minutes to make a payment. If no payment is made during the additional time, the order is finally considered unpaid.\n\nThis is indicated in the `Order.paymentStatus` value that changes to `FAILED`. In addition, a [notification](../../merchant-api/webhook) about the order payment status change is sent. If the merchant reserved the item, the order can be canceled after the status changes.\n\nTime-to-live (seconds): `180 <= ttl <= 604800`\n\nTime-to-live (when generating a link in the personal account, seconds): `86400`",
"format": "int32",
"type": "integer"
}
},
"required": [
"cart",
"currencyCode",
"orderId"
],
"type": "object"
},
"CreateOrderResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
},
"CreateOrderResponseData": {
"properties": {
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl"
],
"type": "object"
},
"CreateSubscriptionRequest": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"externalId": {
"description": "Cart ID passed by the merchant",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Cart items that the customer pays for.",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Number of Plus points\n\nThe field is read-only. Any passed values are ignored.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product id in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique id that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total price per item with item discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Total price per product unit without discount",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Final order cost."
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Cart"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"futureWriteOffAmount": {
"description": "Amount to be debited in the future",
"example": "123.45",
"format": "double",
"type": "string"
},
"intervalCount": {
"description": "Number of subscription periods in time units specified in `intervalUnit`.\n\nFor example, for a 6-month subscription, specify: `intervalUnit: 'MONTH'`, `intervalCount: 6`.\n\nRequired if `isBinding=True` is not specified.",
"example": "6",
"format": "int32",
"type": "integer"
},
"intervalUnit": {
"description": "Time unit of the subscription frequency.\n\nRequired if `isBinding=True` is not specified.",
"enum": [
"SECOND",
"DAY",
"WEEK",
"MONTH",
"YEAR",
null
],
"type": "string"
},
"isBinding": {
"default": false,
"description": "Allows linking the user's card with no items added to the cart.\n\nIf the first transaction is only for card binding, pass `isBinding: true` in the request.\n\nIn this scenario, you don't need to pass the cart or subscription period.",
"type": "boolean"
},
"metadata": {
"description": "Arbitrary order data for internal use",
"maxLength": 2048,
"type": "string"
},
"orderId": {
"description": "Order ID on the merchant side (it should be unique). Further interaction on the payment request will be carried out using this ID. The ID will also be used at reconciliation",
"maxLength": 2048,
"type": "string"
},
"orderSource": {
"default": null,
"description": "Indicates where order creation was initialized\n\nUsed for subsequent analysis\n\n---\n\n**WEBSITE**: The button is placed on a website. A payment link is generated after certain user actions (clicking the button) on the website\n\n**APP**: The button is placed in a mobile app. A payment link is generated after certain user actions (tapping the button) in the app\n\n**CRM**: A payment link is generated by a manager in the CRM system or another admin panel\n\n**CASH_REGISTER**: A payment link is generated to be displayed in the offline cash register\n\n**CMS_PLUGIN**: A payment link is generated in the CMS plugin\n\n**TV**: A payment link is generated to be displayed on a TV platform",
"enum": [
"WEBSITE",
"APP",
"CRM",
"CASH_REGISTER",
"CMS_PLUGIN",
"TV"
],
"type": "string"
},
"purpose": {
"description": "Purpose of payment",
"maxLength": 1000,
"type": "string"
},
"redirectUrls": {
"allOf": [
{
"properties": {
"onAbort": {
"description": "Link to redirect the user on payment cancellation. Payment can be canceled by the user in the payment form.",
"maxLength": 2048,
"type": "string"
},
"onError": {
"description": "The field is required for online stores only. A link to redirect the user in case of a payment error or TTL expiry for a payment link",
"maxLength": 2048,
"type": "string"
},
"onSuccess": {
"description": "The field is required for online stores only. Link to redirect the user on payment success.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"onError",
"onSuccess"
],
"type": "object"
}
],
"description": "Links for redirecting the user from the payment form. Required for online stores."
},
"title": {
"description": "Subscription name",
"maxLength": 30,
"type": "string"
},
"trialCount": {
"description": "Number of subscription trial periods specified in `trialUnit`.\n\nFor example, for a subscription with a 7-day trial period, specify: `trialUnit: 'DAY'`, `trialCount: 7`.",
"format": "int32",
"type": "integer"
},
"trialEndAt": {
"description": "Trial period end date. Mutually exclusive with the `trial_unit` + `trial_count` fields.",
"format": "date-time",
"type": "string"
},
"trialUnit": {
"description": "Time unit of the trial subscription.",
"enum": [
"SECOND",
"DAY",
"WEEK",
"MONTH",
"YEAR",
null
],
"type": "string"
},
"ttl": {
"default": 1800,
"description": "Order's time to live (in seconds)\n\n`180 <= ttl <= 604800`",
"format": "int32",
"type": "integer"
}
},
"required": [
"currencyCode",
"orderId"
],
"type": "object"
},
"CreateSubscriptionResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
},
"subscriptionId": {
"description": "Subscription ID",
"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": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
},
"subscriptionId": {
"description": "Subscription ID",
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl",
"subscriptionId"
],
"type": "object"
},
"CustomerAggregates": {
"properties": {
"amountFirstSuccessfulOrder": {
"description": "Amount of the first successful order",
"example": "123.45",
"format": "double",
"type": "string"
},
"amountLatestSuccessfulOrder": {
"description": "Amount of the last successful order",
"example": "123.45",
"format": "double",
"type": "string"
},
"cookie": {
"description": "Cookies",
"maxLength": 2048,
"type": "string"
},
"daysSinceLastPasswordReset": {
"description": "How many days have passed since the last password reset",
"format": "int32",
"type": "integer"
},
"failedLoginAttemptsOneDay": {
"description": "Number of failed login attempts over the past day",
"format": "int32",
"type": "integer"
},
"failedLoginAttemptsSevenDays": {
"description": "Number of failed login attempts over the past 7 days",
"format": "int32",
"type": "integer"
},
"firstSuccessfulOrderDate": {
"description": "Date of the first successful order in the order history",
"format": "date",
"type": "string"
},
"historicalCookieLogin": {
"description": "Login with saved cookies (user previously paid for an order)",
"type": "boolean"
},
"historicalDeviceLogin": {
"description": "Login from a saved device (user previously paid for an order)",
"type": "boolean"
},
"lastPasswordResetDate": {
"description": "Date of the last password reset",
"format": "date",
"type": "string"
},
"latestSuccessfulOrderLastYearDate": {
"description": "Date of the last successful order over the past year",
"format": "date",
"type": "string"
},
"previousSuccessfulOrdersAtSameAddress": {
"description": "Whether the user has previously completed a successful order at the current address",
"type": "boolean"
},
"redemptionRateLastHalfYear": {
"description": "Buyout percentage over the past 6 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"registrationDate": {
"description": "Date of user registration on the merchant's website",
"format": "date",
"type": "string"
}
},
"type": "object"
},
"CustomerSubscriptionResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"cancelledAt": {
"description": "Subscription cancellation time",
"format": "date-time",
"type": "string"
},
"customerSubscriptionId": {
"description": "Subscription ID",
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"isCardActive": {
"description": "Linked card's status",
"type": "boolean"
},
"nextWriteOff": {
"description": "Date of next debit",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Subscription type",
"enum": [
"NEW",
"ACTIVE",
"CANCELLED",
"EXPIRED"
],
"type": "string"
},
"subscriptionPlanId": {
"description": "Subscription plan 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": "Subscription cancellation time",
"format": "date-time",
"type": "string"
},
"customerSubscriptionId": {
"description": "Subscription ID",
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"isCardActive": {
"description": "Linked card's status",
"type": "boolean"
},
"nextWriteOff": {
"description": "Date of next debit",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Subscription type",
"enum": [
"NEW",
"ACTIVE",
"CANCELLED",
"EXPIRED"
],
"type": "string"
},
"subscriptionPlanId": {
"description": "Subscription plan ID",
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"status",
"subscriptionPlanId"
],
"type": "object"
},
"Delivery": {
"properties": {
"actualPrice": {
"description": "Delivery cost for the merchant",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the delivery was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"price": {
"description": "Delivery cost for the customer",
"example": "123.45",
"format": "double",
"type": "string"
},
"status": {
"default": "NEW",
"description": "Delivery status",
"enum": [
"NEW",
"ESTIMATING",
"EXPIRED",
"READY_FOR_APPROVAL",
"COLLECTING",
"PREPARING",
"DELIVERING",
"DELIVERED",
"RETURNING",
"RETURNED",
"FAILED",
"CANCELLED"
],
"type": "string"
},
"updated": {
"description": "Date and time when the delivery was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"price"
],
"type": "object"
},
"Discount": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"FlexibleCustomerChoice": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"allOf": [
{
"properties": {
"end": {
"description": "Interval end time",
"type": "string"
},
"start": {
"description": "Interval start time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
]
}
},
"required": [
"date"
],
"type": "object"
},
"FlexibleTimeIntervals": {
"properties": {
"grid": {
"allOf": [
{
"properties": {
"duration": {
"description": "Duration of each interval",
"type": "string"
},
"end": {
"description": "Maximum start time for the latest interval",
"type": "string"
},
"start": {
"description": "Start time for the very first interval",
"type": "string"
},
"step": {
"description": "Difference in time between the starts of two neighboring intervals",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
}
],
"description": "Encodes the intervals as a grid. Use this format if you want to set more than 20 delivery intervals.\nExample: `{\"start\": \"09:00\", \"end\": \"21:00\", \"duration\": \"00:20\", \"step\": \"01:00\"}` is treated as a set of intervals: `[{\"start\": \"09:00\", \"end\": \"09:20\"}, {\"start\": \"10:00\", \"end\": \"10:20\"}, ..., {\"start\": \"20:00\", \"end\": \"20:20\"}]`"
},
"type": {
"description": "For the `GRID` type, fill in the `grid` field. If the `VALUES` type is specified, set the `values` field.",
"enum": [
"GRID",
"VALUES"
],
"type": "string"
},
"values": {
"description": "Specifies the list of intervals directly. Suitable for a small number of delivery intervals. The maximum recommended number of intervals is 20",
"items": {
"properties": {
"end": {
"description": "Interval end time",
"type": "string"
},
"start": {
"description": "Interval start time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
},
"FlexibleTimeIntervalsGridDescriptor": {
"properties": {
"duration": {
"description": "Duration of each interval",
"type": "string"
},
"end": {
"description": "Maximum start time for the latest interval",
"type": "string"
},
"start": {
"description": "Start time for the very first interval",
"type": "string"
},
"step": {
"description": "Difference in time between the starts of two neighboring intervals",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
},
"ItemQuantity": {
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
},
"ItemReceipt": {
"properties": {
"agent": {
"allOf": [
{
"properties": {
"agentType": {
"description": "Agent type by taxable object. See [values](https://pay.yandex.uz/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": "It shouldn't include more than two decimal digits.\nFor example: 1.12, 5.1, 10, or 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": "Value description: [Link](https://pay.yandex.uz/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": "Value description: [Link](https://pay.yandex.uz/ru/docs/custom/backend/fns#payment-method-type)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": "integer"
},
"paymentSubjectType": {
"description": "Value description: [Link](https://pay.yandex.uz/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": "Product code (a base64-encoded array of 1 to 32 bytes)",
"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": "Value description: [Link](https://pay.yandex.uz/ru/docs/custom/backend/fns#tax)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
],
"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": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
},
"MerchantGetHostAppLinkHandlerResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"url": {
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
},
"MerchantGetHostAppLinkHandlerResponseData": {
"properties": {
"url": {
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
},
"MerchantOperationResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (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": "Delivery cost for the merchant",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the delivery was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"price": {
"description": "Delivery cost for the customer",
"example": "123.45",
"format": "double",
"type": "string"
},
"status": {
"default": "NEW",
"description": "Delivery status",
"enum": [
"NEW",
"ESTIMATING",
"EXPIRED",
"READY_FOR_APPROVAL",
"COLLECTING",
"PREPARING",
"DELIVERING",
"DELIVERED",
"RETURNING",
"RETURNED",
"FAILED",
"CANCELLED"
],
"type": "string"
},
"updated": {
"description": "Date and time when the delivery was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"price"
],
"type": "object"
},
"operations": {
"items": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"approvalCode": {
"description": "Code of transaction confirmation received from the processing center.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"type": "array"
},
"order": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "List of cart items",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"finalPrice": {
"description": "Unit price including all item-level and cart-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Total cart cost that the customer is to pay"
}
},
"required": [
"items"
],
"type": "object"
}
],
"description": "Cart"
},
"coolingPeriodExpiresAt": {
"description": "Cooling-off period end date and time (ISO 8601)",
"format": "date-time",
"type": "string"
},
"created": {
"description": "Date and time when the order was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"isPrepayment": {
"default": false,
"description": "Flag indicating whether to process the order using the \"deferred payment\" flow.\n\nIf set to `true`, deferred payment is enabled for the order.",
"type": "boolean"
},
"merchantId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Arbitrary data transmitted at button initialization",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Total cost of the order to be paid, including refunds, delivery costs, discounts, and promo codes",
"example": "123.45",
"format": "double",
"type": "string"
},
"orderId": {
"description": "Merchant-side order ID that was passed in the [/orders](../order/merchant_v1_orders-post.md) request.",
"maxLength": 2048,
"type": "string"
},
"paymentMethod": {
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Payment system",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"SPLIT"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
},
"paymentStatus": {
"description": "For more information, see [Operation statuses](../../../../payments/statuses).",
"enum": [
"PENDING",
"AUTHORIZED",
"CAPTURED",
"VOIDED",
"REFUNDED",
"CONFIRMED",
"PARTIALLY_REFUNDED",
"FAILED",
null
],
"type": "string",
"x-enumDescriptions": {
"AUTHORIZED": "Платеж за заказ авторизован. Средства заблокированы на счету плательщика",
"CAPTURED": "Заказ успешно оплачен. Средства списаны со счета плательщика",
"CONFIRMED": "Заказ успешно оформлен",
"FAILED": "Заказ не был успешно оплачен",
"PARTIALLY_REFUNDED": "Совершен частичный возврат средств за заказ",
"PENDING": "Ожидается оплата",
"REFUNDED": "Совершен возврат средств за заказ",
"VOIDED": "Оплата отменена. Списание средств не производилось"
}
},
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "Order cancellation reason. Applicable to the `VOIDED` and `FAILED` statuses.",
"maxLength": 2048,
"type": "string"
},
"updated": {
"description": "Date and time when the order was updated (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": "Link to redirect the user on payment cancellation. Payment can be canceled by the user in the payment form.",
"maxLength": 2048,
"type": "string"
},
"onError": {
"description": "The field is required for online stores only. A link to redirect the user in case of a payment error or TTL expiry for a payment link",
"maxLength": 2048,
"type": "string"
},
"onSuccess": {
"description": "The field is required for online stores only. Link to redirect the user on payment success.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"onError",
"onSuccess"
],
"type": "object"
},
"MerchantRiskInfo": {
"properties": {
"billingPhone": {
"description": "**DEPRECATED** Customer phone number.<br/>*Use the field with the same name one level up instead.*",
"maxLength": 2048,
"type": "string"
},
"customerAggregates": {
"allOf": [
{
"properties": {
"amountFirstSuccessfulOrder": {
"description": "Amount of the first successful order",
"example": "123.45",
"format": "double",
"type": "string"
},
"amountLatestSuccessfulOrder": {
"description": "Amount of the last successful order",
"example": "123.45",
"format": "double",
"type": "string"
},
"cookie": {
"description": "Cookies",
"maxLength": 2048,
"type": "string"
},
"daysSinceLastPasswordReset": {
"description": "How many days have passed since the last password reset",
"format": "int32",
"type": "integer"
},
"failedLoginAttemptsOneDay": {
"description": "Number of failed login attempts over the past day",
"format": "int32",
"type": "integer"
},
"failedLoginAttemptsSevenDays": {
"description": "Number of failed login attempts over the past 7 days",
"format": "int32",
"type": "integer"
},
"firstSuccessfulOrderDate": {
"description": "Date of the first successful order in the order history",
"format": "date",
"type": "string"
},
"historicalCookieLogin": {
"description": "Login with saved cookies (user previously paid for an order)",
"type": "boolean"
},
"historicalDeviceLogin": {
"description": "Login from a saved device (user previously paid for an order)",
"type": "boolean"
},
"lastPasswordResetDate": {
"description": "Date of the last password reset",
"format": "date",
"type": "string"
},
"latestSuccessfulOrderLastYearDate": {
"description": "Date of the last successful order over the past year",
"format": "date",
"type": "string"
},
"previousSuccessfulOrdersAtSameAddress": {
"description": "Whether the user has previously completed a successful order at the current address",
"type": "boolean"
},
"redemptionRateLastHalfYear": {
"description": "Buyout percentage over the past 6 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"registrationDate": {
"description": "Date of user registration on the merchant's website",
"format": "date",
"type": "string"
}
},
"type": "object"
}
],
"description": "Aggregate customer data"
},
"deviceId": {
"description": "Customer device ID (device_id/gaid/idfa/ifv)",
"maxLength": 2048,
"type": "string"
},
"isExpressShipping": {
"description": "Express delivery flag",
"type": "boolean"
},
"merchantMcc": {
"description": "Merchant category code (MCC)",
"maxLength": 2048,
"type": "string"
},
"merchantName": {
"description": "Merchant name",
"maxLength": 2048,
"type": "string"
},
"merchantOfflinePosLegalAddress": {
"description": "Offline POS legal address",
"maxLength": 2048,
"type": "string"
},
"merchantTaxRefNumber": {
"description": "Merchant tax ID",
"maxLength": 2048,
"type": "string"
},
"periodCheckAggregates": {
"allOf": [
{
"properties": {
"successfulOrdersCountNineMonths": {
"description": "Number of successful orders over the past 9 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountOneMonth": {
"description": "Number of successful orders over the past month",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountSixMonths": {
"description": "Number of successful orders over the past 6 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountThreeMonths": {
"description": "Number of successful orders over the past 3 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountTwelveMonths": {
"description": "Number of successful orders over the past 12 months",
"format": "int32",
"type": "integer"
},
"totalAmountSuccessfulOrdersNineMonths": {
"description": "Total amount of successful orders over the past 9 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersOneMonth": {
"description": "Total amount of successful orders over the past month",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersSixMonths": {
"description": "Total amount of successful orders over the past 6 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersThreeMonths": {
"description": "Total amount of successful orders over the past 3 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersTwelveMonths": {
"description": "Total amount of successful orders over the past 12 months",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"type": "object"
}
],
"description": "Aggregate data on receipts over different periods"
},
"qrType": {
"description": "QR code type",
"enum": [
"static",
"dynamic",
null
],
"type": "string"
},
"qrcId": {
"description": "QR code ID",
"maxLength": 2048,
"type": "string"
},
"shippingAddress": {
"description": "Delivery address. If the `PICKUP` order delivery method is selected, specify the pickup point address.",
"maxLength": 2048,
"type": "string"
},
"shippingPhone": {
"description": "Recipient phone number (e.g., +998123456789)",
"maxLength": 2048,
"type": "string"
},
"shippingType": {
"description": "Order delivery method",
"enum": [
"COURIER",
"PICKUP",
null
],
"type": "string"
}
},
"type": "object"
},
"Operation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"OperationResponseData": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (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": "The field is required for offline stores only. ID of the point of sale",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"default": null,
"description": "The field is required for offline stores only. Manager ID",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
}
],
"description": "Information about where the order was placed and who placed it."
},
"paymentData": {
"allOf": [
{
"properties": {
"saleToken": {
"description": "Unique ID generated by the cash register for each payment transaction",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
}
],
"description": "Additional payment parameters"
},
"qrData": {
"allOf": [
{
"properties": {
"token": {
"description": "QR token",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
}
],
"description": "Additional parameters for sending a link for payment via QR code."
},
"smsOffer": {
"allOf": [
{
"properties": {
"phone": {
"description": "Customer phone number (such as `+998123456789`) for SMS notifications.\nFor offline stores only.",
"maxLength": 2048,
"pattern": "^\\+\\d+$",
"type": "string"
}
},
"required": [
"phone"
],
"type": "object"
}
],
"description": "Additional parameters for sending a link for payment via SMS.\n\nThe field is required for offline stores only."
}
},
"type": "object"
},
"OrderResponseData": {
"properties": {
"delivery": {
"properties": {
"actualPrice": {
"description": "Delivery cost for the merchant",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the delivery was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"price": {
"description": "Delivery cost for the customer",
"example": "123.45",
"format": "double",
"type": "string"
},
"status": {
"default": "NEW",
"description": "Delivery status",
"enum": [
"NEW",
"ESTIMATING",
"EXPIRED",
"READY_FOR_APPROVAL",
"COLLECTING",
"PREPARING",
"DELIVERING",
"DELIVERED",
"RETURNING",
"RETURNED",
"FAILED",
"CANCELLED"
],
"type": "string"
},
"updated": {
"description": "Date and time when the delivery was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"price"
],
"type": "object"
},
"operations": {
"items": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"approvalCode": {
"description": "Code of transaction confirmation received from the processing center.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"type": "array"
},
"order": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "List of cart items",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"finalPrice": {
"description": "Unit price including all item-level and cart-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Total cart cost that the customer is to pay"
}
},
"required": [
"items"
],
"type": "object"
}
],
"description": "Cart"
},
"coolingPeriodExpiresAt": {
"description": "Cooling-off period end date and time (ISO 8601)",
"format": "date-time",
"type": "string"
},
"created": {
"description": "Date and time when the order was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"isPrepayment": {
"default": false,
"description": "Flag indicating whether to process the order using the \"deferred payment\" flow.\n\nIf set to `true`, deferred payment is enabled for the order.",
"type": "boolean"
},
"merchantId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Arbitrary data transmitted at button initialization",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Total cost of the order to be paid, including refunds, delivery costs, discounts, and promo codes",
"example": "123.45",
"format": "double",
"type": "string"
},
"orderId": {
"description": "Merchant-side order ID that was passed in the [/orders](../order/merchant_v1_orders-post.md) request.",
"maxLength": 2048,
"type": "string"
},
"paymentMethod": {
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Payment system",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"SPLIT"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
},
"paymentStatus": {
"description": "For more information, see [Operation statuses](../../../../payments/statuses).",
"enum": [
"PENDING",
"AUTHORIZED",
"CAPTURED",
"VOIDED",
"REFUNDED",
"CONFIRMED",
"PARTIALLY_REFUNDED",
"FAILED",
null
],
"type": "string",
"x-enumDescriptions": {
"AUTHORIZED": "Платеж за заказ авторизован. Средства заблокированы на счету плательщика",
"CAPTURED": "Заказ успешно оплачен. Средства списаны со счета плательщика",
"CONFIRMED": "Заказ успешно оформлен",
"FAILED": "Заказ не был успешно оплачен",
"PARTIALLY_REFUNDED": "Совершен частичный возврат средств за заказ",
"PENDING": "Ожидается оплата",
"REFUNDED": "Совершен возврат средств за заказ",
"VOIDED": "Оплата отменена. Списание средств не производилось"
}
},
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "Order cancellation reason. Applicable to the `VOIDED` and `FAILED` statuses.",
"maxLength": 2048,
"type": "string"
},
"updated": {
"description": "Date and time when the order was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"cart",
"currencyCode"
],
"type": "object"
}
},
"type": "object"
},
"OrderResponseOperation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"approvalCode": {
"description": "Code of transaction confirmation received from the processing center.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"PaymentData": {
"properties": {
"saleToken": {
"description": "Unique ID generated by the cash register for each payment transaction",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
},
"PaymentMethod": {
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Payment system",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"SPLIT"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
},
"PaymentsOperator": {
"properties": {
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PeriodCheckAggregates": {
"properties": {
"successfulOrdersCountNineMonths": {
"description": "Number of successful orders over the past 9 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountOneMonth": {
"description": "Number of successful orders over the past month",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountSixMonths": {
"description": "Number of successful orders over the past 6 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountThreeMonths": {
"description": "Number of successful orders over the past 3 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountTwelveMonths": {
"description": "Number of successful orders over the past 12 months",
"format": "int32",
"type": "integer"
},
"totalAmountSuccessfulOrdersNineMonths": {
"description": "Total amount of successful orders over the past 9 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersOneMonth": {
"description": "Total amount of successful orders over the past month",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersSixMonths": {
"description": "Total amount of successful orders over the past 6 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersThreeMonths": {
"description": "Total amount of successful orders over the past 3 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersTwelveMonths": {
"description": "Total amount of successful orders over the past 12 months",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"type": "object"
},
"PickupOption": {
"properties": {
"address": {
"description": "Address in string format",
"maxLength": 2048,
"type": "string"
},
"allowedPaymentMethods": {
"description": "Individual payment methods for the selected pickup method. Methods that can be used to pay for the order with the selected pickup method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY",
"UNIQR_REUSABLE",
"UNIQR_ONETIME"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Cost of delivery to the location",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Additional description",
"maxLength": 2048,
"type": "string"
},
"fromDate": {
"description": "YYYY-MM-DD. Closest possible delivery date",
"format": "date",
"type": "string"
},
"location": {
"properties": {
"latitude": {
"format": "float",
"type": "number"
},
"longitude": {
"format": "float",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"phones": {
"description": "Contact phone numbers",
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"pickupPointId": {
"description": "Unique pickup point ID in the merchant's system",
"maxLength": 2048,
"type": "string"
},
"provider": {
"description": "Pickup point type",
"enum": [
"YANDEX_MARKET",
"BOXBERRY",
"CDEK",
"IN_STORE",
"RUSSIAN_POST",
"PICKPOINT",
"DPD"
],
"type": "string"
},
"schedule": {
"description": "Pickup point's schedule",
"items": {
"properties": {
"fromTime": {
"description": "HH:mm, \"08:00\"",
"type": "string"
},
"label": {
"description": "For example, \"Mon-Fri\"",
"maxLength": 2048,
"type": "string"
},
"toTime": {
"description": "HH:mm, \"20:00\"",
"type": "string"
}
},
"required": [
"fromTime",
"label",
"toTime"
],
"type": "object"
},
"type": "array"
},
"storagePeriod": {
"description": "Optional. Storage period at the pickup point, in days.",
"format": "int32",
"type": "integer"
},
"title": {
"description": "Pickup point's name",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "YYYY-MM-DD. Latest delivery date",
"format": "date",
"type": "string"
}
},
"required": [
"address",
"location",
"pickupPointId",
"title"
],
"type": "object"
},
"PickupSchedule": {
"properties": {
"fromTime": {
"description": "HH:mm, \"08:00\"",
"type": "string"
},
"label": {
"description": "For example, \"Mon-Fri\"",
"maxLength": 2048,
"type": "string"
},
"toTime": {
"description": "HH:mm, \"20:00\"",
"type": "string"
}
},
"required": [
"fromTime",
"label",
"toTime"
],
"type": "object"
},
"QRData": {
"properties": {
"token": {
"description": "QR token",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
},
"RecurSubscriptionRequest": {
"properties": {
"amount": {
"description": "Amount to be debited",
"example": "123.45",
"format": "double",
"type": "string"
},
"cart": {
"allOf": [
{
"properties": {
"externalId": {
"description": "Cart ID passed by the merchant",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Cart items that the customer pays for.",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Number of Plus points\n\nThe field is read-only. Any passed values are ignored.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product id in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique id that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total price per item with item discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Total price per product unit without discount",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Final order cost."
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Cart"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Arbitrary order data for internal use",
"maxLength": 2048,
"type": "string"
},
"orderId": {
"description": "The order ID on the merchant side (it should be unique).",
"maxLength": 2048,
"type": "string"
},
"parentOrderId": {
"description": "ID of the initial order",
"maxLength": 2048,
"type": "string"
},
"purpose": {
"description": "Purpose of payment",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"amount",
"cart",
"currencyCode",
"orderId",
"parentOrderId"
],
"type": "object"
},
"RecurSubscriptionResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"operationId"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
},
"RecurSubscriptionResponseData": {
"properties": {
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"operationId"
],
"type": "object"
},
"RefundRequest": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Final cart"
},
"externalOperationId": {
"description": "Operation ID in the merchant's system",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Total amount of the order. Equal to `cart.total.amount` + `shipping.amount`",
"example": "123.45",
"format": "double",
"type": "string"
},
"refundAmount": {
"description": "Refund amount.",
"example": "123.45",
"format": "double",
"type": "string"
},
"shipping": {
"properties": {
"amount": {
"description": "It shouldn't include more than two decimal digits.\nFor example: 1.12, 5.1, 10, or 11.00.",
"example": "123.45",
"format": "double",
"type": "string"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
}
},
"required": [
"amount",
"methodType"
],
"type": "object"
}
},
"required": [
"orderAmount",
"refundAmount"
],
"type": "object"
},
"RefundV2Request": {
"properties": {
"branchId": {
"description": "ID of the point of sale",
"maxLength": 2048,
"type": "string"
},
"externalOperationId": {
"description": "Refund operation ID in the merchant system. Make sure it's unique.\n\nPass this parameter to track the refund operation status via the [operations/{external_operation_id}](../operation/merchant_v1_operations-get) method.\n\nIf the operation is not completed (is either in progress or stopped), repeated refund requests with the same arguments and `externalOperationId` are idempotent — the response will return the same operation. Otherwise, an error is returned.\n\nIf the refund process is launched successfully, calling the refund method with the same `externalOperationId` again will return an error with the `reasonCode: \"DUPLICATE_EXTERNAL_OPERATION_ID\"`.",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"description": "Manager ID",
"maxLength": 2048,
"type": "string"
},
"motive": {
"description": "Refund reason",
"maxLength": 2048,
"type": "string"
},
"refundAmount": {
"description": "Refund amount.",
"example": "123.45",
"format": "double",
"type": "string"
},
"refundCart": {
"allOf": [
{
"properties": {
"items": {
"items": {
"properties": {
"price": {
"description": "Unit price after the operation.\nRequired if the unit price is reduced as a result of the operation.\nUseful when refunding part of the amount or when confirming the order.\nIf not specified, the price is assumed to remain unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
},
"productId": {
"description": "Cart item ID at the time the order was created.\nIf you pass an ID that was not present in the initial cart, an error occurs.",
"maxLength": 2048,
"type": "string"
},
"quantityCount": {
"description": "Quantity of items for the refund operation.\n\nThe value depends on the cart used:\n\n- If it's `targetCart`, the `quantityCount` field shows the number of items remaining after the refund (if there are 5 items and 3 are specified, 2 are refunded).\n- If it's `refundCart`, the `quantityCount` field shows the number of items to be refunded (if there are 5 items and 3 are specified, 3 are refunded).\n\nIf the field is empty, the number of items remains unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Specifies the cart items to be refunded.\nCan't be specified concurrently with the `targetCart` field value.\nWe recommend passing this parameter value along with the `externalOperationId` value because it's used as the idempotency key."
},
"targetCart": {
"allOf": [
{
"properties": {
"items": {
"items": {
"properties": {
"price": {
"description": "Unit price after the operation.\nRequired if the unit price is reduced as a result of the operation.\nUseful when refunding part of the amount or when confirming the order.\nIf not specified, the price is assumed to remain unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
},
"productId": {
"description": "Cart item ID at the time the order was created.\nIf you pass an ID that was not present in the initial cart, an error occurs.",
"maxLength": 2048,
"type": "string"
},
"quantityCount": {
"description": "Quantity of items for the refund operation.\n\nThe value depends on the cart used:\n\n- If it's `targetCart`, the `quantityCount` field shows the number of items remaining after the refund (if there are 5 items and 3 are specified, 2 are refunded).\n- If it's `refundCart`, the `quantityCount` field shows the number of items to be refunded (if there are 5 items and 3 are specified, 3 are refunded).\n\nIf the field is empty, the number of items remains unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Shows the final cart status after the refund.\nIf the field is omitted, it's considered that the cart is refunded in full. Can't be specified concurrently with the `refundCart` field value."
},
"targetShipping": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cost of delivery after the operation is completed",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"type": "object"
}
],
"description": "Applicable to Yandex Pay Checkout only. In all other cases, leave the field empty.\n\nShows the final delivery status after the refund.\nIf the field is omitted or is `null`, it's considered that the delivery cost is refunded in full."
}
},
"required": [
"refundAmount"
],
"type": "object"
},
"RenderedCart": {
"description": "{% note info %}\n\nPass the delivery cost in `items` as a separate product.\n\n{% endnote %}",
"properties": {
"externalId": {
"description": "Cart ID on the merchant side",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "List of cart items",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Final order cost."
}
},
"required": [
"items",
"total"
],
"type": "object"
},
"RenderedCart1": {
"properties": {
"externalId": {
"description": "Cart ID passed by the merchant",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Cart items that the customer pays for.",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Number of Plus points\n\nThe field is read-only. Any passed values are ignored.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product id in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique id that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total price per item with item discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Total price per product unit without discount",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Final order cost."
}
},
"required": [
"items",
"total"
],
"type": "object"
},
"RenderedCartItem": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"RenderedCartItem1": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Number of Plus points\n\nThe field is read-only. Any passed values are ignored.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product id in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique id that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total price per item with item discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Total price per product unit without discount",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"SMSOffer": {
"properties": {
"phone": {
"description": "Customer phone number (such as `+998123456789`) for SMS notifications.\nFor offline stores only.",
"maxLength": 2048,
"pattern": "^\\+\\d+$",
"type": "string"
}
},
"required": [
"phone"
],
"type": "object"
},
"ShippingMethod": {
"properties": {
"courierOption": {
"allOf": [
{
"properties": {
"allowedPaymentMethods": {
"description": "Individual payment methods for the delivery method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY",
"UNIQR_REUSABLE",
"UNIQR_ONETIME"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Delivery cost",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"courierOptionId": {
"description": "ID of the selected delivery method in the merchant system",
"maxLength": 2048,
"type": "string"
},
"customerChoice": {
"allOf": [
{
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"allOf": [
{
"properties": {
"end": {
"description": "Interval end time",
"type": "string"
},
"start": {
"description": "Interval start time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
]
}
},
"required": [
"date"
],
"type": "object"
}
],
"description": "Date and interval selected by the user. Only for `type: FLEXIBLE`"
},
"fromDate": {
"description": "Closest delivery date for `type: PLAIN`. Start of the interval of the delivery date selection for `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"fromTime": {
"description": "Start of the delivery time interval. Only for `type: PLAIN`",
"type": "string"
},
"provider": {
"description": "Delivery service type.",
"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"
},
"timeIntervals": {
"allOf": [
{
"properties": {
"grid": {
"allOf": [
{
"properties": {
"duration": {
"description": "Duration of each interval",
"type": "string"
},
"end": {
"description": "Maximum start time for the latest interval",
"type": "string"
},
"start": {
"description": "Start time for the very first interval",
"type": "string"
},
"step": {
"description": "Difference in time between the starts of two neighboring intervals",
"type": "string"
}
},
"required": [
"duration",
"end",
"start",
"step"
],
"type": "object"
}
],
"description": "Encodes the intervals as a grid. Use this format if you want to set more than 20 delivery intervals.\nExample: `{\"start\": \"09:00\", \"end\": \"21:00\", \"duration\": \"00:20\", \"step\": \"01:00\"}` is treated as a set of intervals: `[{\"start\": \"09:00\", \"end\": \"09:20\"}, {\"start\": \"10:00\", \"end\": \"10:20\"}, ..., {\"start\": \"20:00\", \"end\": \"20:20\"}]`"
},
"type": {
"description": "For the `GRID` type, fill in the `grid` field. If the `VALUES` type is specified, set the `values` field.",
"enum": [
"GRID",
"VALUES"
],
"type": "string"
},
"values": {
"description": "Specifies the list of intervals directly. Suitable for a small number of delivery intervals. The maximum recommended number of intervals is 20",
"items": {
"properties": {
"end": {
"description": "Interval end time",
"type": "string"
},
"start": {
"description": "Interval start time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "Codes the intervals of the delivery time available for selection. Only for `type: FLEXIBLE`"
},
"title": {
"description": "Delivery method name. Shown to the user in the option list",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "Latest delivery date for `type: PLAIN`. End of the delivery date selection range for `type: FLEXIBLE`",
"format": "date",
"type": "string"
},
"toTime": {
"description": "End of the delivery time interval. Only for `type: PLAIN`",
"type": "string"
},
"type": {
"default": "PLAIN",
"description": "Option type.\nFor `FLEXIBLE` delivery options, the user can select the desired date and interval:\n- The delivery date is selected by the customer within the range `[fromDate, toDate]`\n- To give the user an option to select an interval within a day, fill out `timeIntervals`\nNo such choice is provided for `PLAIN` options.",
"enum": [
"PLAIN",
"FLEXIBLE"
],
"type": "string"
}
},
"required": [
"amount",
"category",
"courierOptionId",
"title"
],
"type": "object"
}
],
"description": "if methodType == COURIER"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
},
"pickupOption": {
"allOf": [
{
"properties": {
"address": {
"description": "Address in string format",
"maxLength": 2048,
"type": "string"
},
"allowedPaymentMethods": {
"description": "Individual payment methods for the selected pickup method. Methods that can be used to pay for the order with the selected pickup method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY",
"UNIQR_REUSABLE",
"UNIQR_ONETIME"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Cost of delivery to the location",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Additional description",
"maxLength": 2048,
"type": "string"
},
"fromDate": {
"description": "YYYY-MM-DD. Closest possible delivery date",
"format": "date",
"type": "string"
},
"location": {
"properties": {
"latitude": {
"format": "float",
"type": "number"
},
"longitude": {
"format": "float",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"phones": {
"description": "Contact phone numbers",
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
},
"pickupPointId": {
"description": "Unique pickup point ID in the merchant's system",
"maxLength": 2048,
"type": "string"
},
"provider": {
"description": "Pickup point type",
"enum": [
"YANDEX_MARKET",
"BOXBERRY",
"CDEK",
"IN_STORE",
"RUSSIAN_POST",
"PICKPOINT",
"DPD"
],
"type": "string"
},
"schedule": {
"description": "Pickup point's schedule",
"items": {
"properties": {
"fromTime": {
"description": "HH:mm, \"08:00\"",
"type": "string"
},
"label": {
"description": "For example, \"Mon-Fri\"",
"maxLength": 2048,
"type": "string"
},
"toTime": {
"description": "HH:mm, \"20:00\"",
"type": "string"
}
},
"required": [
"fromTime",
"label",
"toTime"
],
"type": "object"
},
"type": "array"
},
"storagePeriod": {
"description": "Optional. Storage period at the pickup point, in days.",
"format": "int32",
"type": "integer"
},
"title": {
"description": "Pickup point's name",
"maxLength": 2048,
"type": "string"
},
"toDate": {
"description": "YYYY-MM-DD. Latest delivery date",
"format": "date",
"type": "string"
}
},
"required": [
"address",
"location",
"pickupPointId",
"title"
],
"type": "object"
}
],
"description": "if methodType == PICKUP"
},
"yandexDeliveryOption": {
"allOf": [
{
"properties": {
"allowedPaymentMethods": {
"description": "Individual payment methods for the delivery method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY",
"UNIQR_REUSABLE",
"UNIQR_ONETIME"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Delivery cost",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"fromDatetime": {
"format": "date-time",
"type": "string"
},
"title": {
"description": "Delivery method name. Shown to the user in the option list",
"maxLength": 2048,
"type": "string"
},
"toDatetime": {
"format": "date-time",
"type": "string"
},
"yandexDeliveryOptionId": {
"description": "ID of the Yandex Delivery offer",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"category",
"title",
"yandexDeliveryOptionId"
],
"type": "object"
}
],
"description": "if methodType == YANDEX_DELIVERY"
}
},
"required": [
"methodType"
],
"type": "object"
},
"ShippingPrice": {
"properties": {
"amount": {
"description": "It shouldn't include more than two decimal digits.\nFor example: 1.12, 5.1, 10, or 11.00.",
"example": "123.45",
"format": "double",
"type": "string"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
}
},
"required": [
"amount",
"methodType"
],
"type": "object"
},
"StorageInitialPaymentOptions": {
"properties": {
"amount": {
"description": "It shouldn't include more than two decimal digits.\nFor example: 1.12, 5.1, 10, or 11.00.",
"example": "123.45",
"format": "double",
"type": "string"
},
"cardId": {
"maxLength": 2048,
"type": "string"
},
"merchantId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"paymentMethod": {
"enum": [
"CARD",
"SPLIT",
"SBP",
"SPLIT_SBP",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY",
"UNIQR_REUSABLE",
"UNIQR_ONETIME",
null
],
"type": "string"
},
"publicConstructor": {
"maxLength": 2048,
"type": "string"
},
"sessionId": {
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
},
"SubmitRequest": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Final cart"
},
"externalOperationId": {
"description": "Operation ID in the merchant's system",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Total amount of the order. Equal to `cart.total.amount`.\n\nThe field is required if `cart` is passed.",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"externalOperationId"
],
"type": "object"
},
"SuccessResponse": {
"properties": {
"code": {
"default": 200
},
"data": {
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
},
"Supplier": {
"properties": {
"inn": {
"maxLength": 2048,
"type": "string"
},
"name": {
"maxLength": 2048,
"type": "string"
},
"phones": {
"items": {
"maxLength": 2048,
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TargetCart": {
"properties": {
"items": {
"items": {
"properties": {
"price": {
"description": "Unit price after the operation.\nRequired if the unit price is reduced as a result of the operation.\nUseful when refunding part of the amount or when confirming the order.\nIf not specified, the price is assumed to remain unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
},
"productId": {
"description": "Cart item ID at the time the order was created.\nIf you pass an ID that was not present in the initial cart, an error occurs.",
"maxLength": 2048,
"type": "string"
},
"quantityCount": {
"description": "Quantity of items for the refund operation.\n\nThe value depends on the cart used:\n\n- If it's `targetCart`, the `quantityCount` field shows the number of items remaining after the refund (if there are 5 items and 3 are specified, 2 are refunded).\n- If it's `refundCart`, the `quantityCount` field shows the number of items to be refunded (if there are 5 items and 3 are specified, 3 are refunded).\n\nIf the field is empty, the number of items remains unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"TargetCartItem": {
"properties": {
"price": {
"description": "Unit price after the operation.\nRequired if the unit price is reduced as a result of the operation.\nUseful when refunding part of the amount or when confirming the order.\nIf not specified, the price is assumed to remain unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
},
"productId": {
"description": "Cart item ID at the time the order was created.\nIf you pass an ID that was not present in the initial cart, an error occurs.",
"maxLength": 2048,
"type": "string"
},
"quantityCount": {
"description": "Quantity of items for the refund operation.\n\nThe value depends on the cart used:\n\n- If it's `targetCart`, the `quantityCount` field shows the number of items remaining after the refund (if there are 5 items and 3 are specified, 2 are refunded).\n- If it's `refundCart`, the `quantityCount` field shows the number of items to be refunded (if there are 5 items and 3 are specified, 3 are refunded).\n\nIf the field is empty, the number of items remains unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId"
],
"type": "object"
},
"TargetShipping": {
"properties": {
"amount": {
"description": "Cost of delivery after the operation is completed",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"type": "object"
},
"TimeInterval": {
"properties": {
"end": {
"description": "Interval end time",
"type": "string"
},
"start": {
"description": "Interval start time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"TransferOperator": {
"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"
},
"UniqrMetadata": {
"properties": {
"paramsId": {
"maxLength": 2048,
"type": "string"
},
"uniQrId": {
"maxLength": 2048,
"type": "string"
}
},
"required": [
"uniQrId"
],
"type": "object"
},
"YandexDeliveryOption": {
"properties": {
"allowedPaymentMethods": {
"description": "Individual payment methods for the delivery method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used.",
"items": {
"enum": [
"CARD",
"SPLIT",
"CASH_ON_DELIVERY",
"CARD_ON_DELIVERY",
"UNIQR_REUSABLE",
"UNIQR_ONETIME"
],
"type": "string"
},
"type": "array"
},
"amount": {
"description": "Delivery cost",
"example": "123.45",
"format": "double",
"type": "string"
},
"category": {
"enum": [
"EXPRESS",
"TODAY",
"STANDARD"
],
"type": "string"
},
"fromDatetime": {
"format": "date-time",
"type": "string"
},
"title": {
"description": "Delivery method name. Shown to the user in the option list",
"maxLength": 2048,
"type": "string"
},
"toDatetime": {
"format": "date-time",
"type": "string"
},
"yandexDeliveryOptionId": {
"description": "ID of the Yandex Delivery offer",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"category",
"title",
"yandexDeliveryOptionId"
],
"type": "object"
}
},
"securitySchemes": {
"ApiKey": {
"in": "header",
"name": "Authorization",
"type": "apiKey"
}
}
},
"info": {
"description": "\n## Headers {#headers}\n\nPass the following HTTP headers in your requests:\n\n- X-Request-Id: <unique request ID>\n- X-Request-Timeout: <request timeout in milliseconds>\n- X-Request-Attempt: <attempt number (0 — first attempt, 1, 2, etc. — retries)>\n\n`X-Request-Id` is needed to debug requests and ensure idempotency of write requests.\nThat's why the same `X-Request-Id` value must be preserved across all retries when receiving\nHTTP 5xx errors or 429 responses.\n\n`X-Request-Timeout` is required for [deadline propagation](https://sre.google/sre-book/addressing-cascading-failures/#deadline-propagation-1)\nduring request processing within the system.\nAvoid timeout values that are less than one second. The maximum timeout value is 10 seconds.\n\n`X-Request-Attempt` is helpful when running general diagnostics.\n\n## Authorizing merchant requests {#auth}\n\nTo use the API, you must obtain an authentication API key.\nPass the token in each request in the HTTP `Authorization` header.\nKey management is available in the [Yandex Split console](https://console.pay.yandex.uz/settings).\nIn the sandbox environment, the API key is equal to the [Merchant ID](../../../console/settings-pay-split.md#merchant-id) value.\n\n```text\n--header 'Authorization: Api-Key <key value>'\n```\n\nIf the token passed in the request is invalid or missing,\nthe server returns the `401 Unauthorized` HTTP status.",
"title": "Yandex Pay API",
"version": "1.0.0"
},
"openapi": "3.0.3",
"paths": {
"/api/merchant/v1/orders": {
"post": {
"description": "Request to create an order. Returns a payment link for the order.",
"operationId": "merchant_v1_orders-post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"availablePaymentMethods": {
"default": null,
"description": "Payment methods that will be available to the customer in the Yandex Split payment form.\n\nPossible values:\n- `[\"SPLIT\"]`: Split only.",
"items": {
"enum": [
"CARD",
"SPLIT"
],
"type": "string"
},
"minItems": 1,
"type": "array"
},
"billingPhone": {
"description": "Customer phone number.\n\nUsed for simplified authorization and may make Split approval more likely.\n\nRecommended phone number format: `+998123456789` or `998123456789`. The string may contain other characters. However, any characters, except numbers, are ignored.\n\nFor example, values like `998123456789`, `+998123456789`, or `+998 (12) 345-67-89` will be processed as `998123456789`.",
"maxLength": 2048,
"type": "string"
},
"cart": {
"allOf": [
{
"description": "{% note info %}\n\nPass the delivery cost in `items` as a separate product.\n\n{% endnote %}",
"properties": {
"externalId": {
"description": "Cart ID on the merchant side",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "List of cart items",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Final order cost."
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Cart"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"extensions": {
"allOf": [
{
"properties": {
"billingReport": {
"allOf": [
{
"properties": {
"branchId": {
"default": null,
"description": "The field is required for offline stores only. ID of the point of sale",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"default": null,
"description": "The field is required for offline stores only. Manager ID",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
}
],
"description": "Information about where the order was placed and who placed it."
},
"paymentData": {
"allOf": [
{
"properties": {
"saleToken": {
"description": "Unique ID generated by the cash register for each payment transaction",
"maxLength": 2048,
"type": "string"
}
},
"type": "object"
}
],
"description": "Additional payment parameters"
},
"qrData": {
"allOf": [
{
"properties": {
"token": {
"description": "QR token",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
}
],
"description": "Additional parameters for sending a link for payment via QR code."
},
"smsOffer": {
"allOf": [
{
"properties": {
"phone": {
"description": "Customer phone number (such as `+998123456789`) for SMS notifications.\nFor offline stores only.",
"maxLength": 2048,
"pattern": "^\\+\\d+$",
"type": "string"
}
},
"required": [
"phone"
],
"type": "object"
}
],
"description": "Additional parameters for sending a link for payment via SMS.\n\nThe field is required for offline stores only."
}
},
"type": "object"
}
],
"default": null,
"description": "Additional parameters for placing an offline order"
},
"isPrepayment": {
"description": "Flag indicating whether to process the order using the \"deferred payment\" flow.\n\nIf set to `true`, deferred payment is enabled for the order.",
"type": "boolean"
},
"metadata": {
"description": "Arbitrary order data for internal use",
"maxLength": 2048,
"type": "string"
},
"orderId": {
"description": "Order ID on the merchant side (it should be unique). Further interaction on the payment request will be carried out using this ID. The ID will also be used at reconciliation",
"maxLength": 2048,
"type": "string"
},
"orderSource": {
"default": null,
"description": "Indicates where order creation was initialized.\n\nUsed for subsequent analysis\n\n---\n\n**WEBSITE**: The button is placed on a website. A payment link is generated after certain user actions (clicking the button) on the website\n\n**APP**: The button is placed in a mobile app. A payment link is generated after certain user actions (tapping the button) in the app\n\n**CRM**: A payment link is generated by a manager in the CRM system or another admin panel\n\n**CASH_REGISTER**: A payment link is generated to be displayed in the offline cash register\n\n**CMS_PLUGIN**: A payment link is generated in the CMS plugin\n\n**TV**: A payment link is generated to be displayed on a TV platform",
"enum": [
"WEBSITE",
"APP",
"CRM",
"CASH_REGISTER",
"CMS_PLUGIN"
],
"type": "string"
},
"preferredPaymentMethod": {
"description": "Preferred payment method.\n\nThe provided method will be automatically selected in the payment form if it does not conflict with the methods specified in `availablePaymentMethods`.",
"enum": [
"FULLPAYMENT",
"SPLIT"
],
"type": "string"
},
"publicConstructor": {
"description": "Constructor of the preselected Split payment plan.\n\n_Available only upon approval_",
"type": "string"
},
"purpose": {
"description": "Purpose of payment",
"maxLength": 1000,
"type": "string"
},
"redirectUrls": {
"allOf": [
{
"properties": {
"onAbort": {
"description": "Link to redirect the user on payment cancellation. Payment can be canceled by the user in the payment form.",
"maxLength": 2048,
"type": "string"
},
"onError": {
"description": "The field is required for online stores only. A link to redirect the user in case of a payment error or TTL expiry for a payment link",
"maxLength": 2048,
"type": "string"
},
"onSuccess": {
"description": "The field is required for online stores only. Link to redirect the user on payment success.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"onError",
"onSuccess"
],
"type": "object"
}
],
"description": "Links for redirecting the user from the payment form. Required for online stores."
},
"risk": {
"allOf": [
{
"properties": {
"billingPhone": {
"description": "**DEPRECATED** Customer phone number.<br/>*Use the field with the same name one level up instead.*",
"maxLength": 2048,
"type": "string"
},
"customerAggregates": {
"allOf": [
{
"properties": {
"amountFirstSuccessfulOrder": {
"description": "Amount of the first successful order",
"example": "123.45",
"format": "double",
"type": "string"
},
"amountLatestSuccessfulOrder": {
"description": "Amount of the last successful order",
"example": "123.45",
"format": "double",
"type": "string"
},
"cookie": {
"description": "Cookies",
"maxLength": 2048,
"type": "string"
},
"daysSinceLastPasswordReset": {
"description": "How many days have passed since the last password reset",
"format": "int32",
"type": "integer"
},
"failedLoginAttemptsOneDay": {
"description": "Number of failed login attempts over the past day",
"format": "int32",
"type": "integer"
},
"failedLoginAttemptsSevenDays": {
"description": "Number of failed login attempts over the past 7 days",
"format": "int32",
"type": "integer"
},
"firstSuccessfulOrderDate": {
"description": "Date of the first successful order in the order history",
"format": "date",
"type": "string"
},
"historicalCookieLogin": {
"description": "Login with saved cookies (user previously paid for an order)",
"type": "boolean"
},
"historicalDeviceLogin": {
"description": "Login from a saved device (user previously paid for an order)",
"type": "boolean"
},
"lastPasswordResetDate": {
"description": "Date of the last password reset",
"format": "date",
"type": "string"
},
"latestSuccessfulOrderLastYearDate": {
"description": "Date of the last successful order over the past year",
"format": "date",
"type": "string"
},
"previousSuccessfulOrdersAtSameAddress": {
"description": "Whether the user has previously completed a successful order at the current address",
"type": "boolean"
},
"redemptionRateLastHalfYear": {
"description": "Buyout percentage over the past 6 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"registrationDate": {
"description": "Date of user registration on the merchant's website",
"format": "date",
"type": "string"
}
},
"type": "object"
}
],
"description": "Aggregate customer data"
},
"deviceId": {
"description": "Customer device ID (device_id/gaid/idfa/ifv)",
"maxLength": 2048,
"type": "string"
},
"isExpressShipping": {
"description": "Express delivery flag",
"type": "boolean"
},
"merchantMcc": {
"description": "Merchant category code (MCC)",
"maxLength": 2048,
"type": "string"
},
"merchantName": {
"description": "Merchant name",
"maxLength": 2048,
"type": "string"
},
"merchantOfflinePosLegalAddress": {
"description": "Offline POS legal address",
"maxLength": 2048,
"type": "string"
},
"merchantTaxRefNumber": {
"description": "Merchant tax ID",
"maxLength": 2048,
"type": "string"
},
"periodCheckAggregates": {
"allOf": [
{
"properties": {
"successfulOrdersCountNineMonths": {
"description": "Number of successful orders over the past 9 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountOneMonth": {
"description": "Number of successful orders over the past month",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountSixMonths": {
"description": "Number of successful orders over the past 6 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountThreeMonths": {
"description": "Number of successful orders over the past 3 months",
"format": "int32",
"type": "integer"
},
"successfulOrdersCountTwelveMonths": {
"description": "Number of successful orders over the past 12 months",
"format": "int32",
"type": "integer"
},
"totalAmountSuccessfulOrdersNineMonths": {
"description": "Total amount of successful orders over the past 9 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersOneMonth": {
"description": "Total amount of successful orders over the past month",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersSixMonths": {
"description": "Total amount of successful orders over the past 6 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersThreeMonths": {
"description": "Total amount of successful orders over the past 3 months",
"example": "123.45",
"format": "double",
"type": "string"
},
"totalAmountSuccessfulOrdersTwelveMonths": {
"description": "Total amount of successful orders over the past 12 months",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"type": "object"
}
],
"description": "Aggregate data on receipts over different periods"
},
"qrType": {
"description": "QR code type",
"enum": [
"static",
"dynamic",
null
],
"type": "string"
},
"qrcId": {
"description": "QR code ID",
"maxLength": 2048,
"type": "string"
},
"shippingAddress": {
"description": "Delivery address. If the `PICKUP` order delivery method is selected, specify the pickup point address.",
"maxLength": 2048,
"type": "string"
},
"shippingPhone": {
"description": "Recipient phone number (e.g., +998123456789)",
"maxLength": 2048,
"type": "string"
},
"shippingType": {
"description": "Order delivery method",
"enum": [
"COURIER",
"PICKUP",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Additional info specifying which may make Split approval more likely. Fully available for online stores only."
},
"ttl": {
"default": 1800,
"description": "This parameter defines how long the user can use the payment link to access the order payment form.\n\nAfter expiration, the user will see the message: \"Payment time expired\".\n\nIf the user follows the link before expiration, they will be given another 15 minutes to make a payment. If no payment is made during the additional time, the order is finally considered unpaid.\n\nThis is indicated in the `Order.paymentStatus` value that changes to `FAILED`. In addition, a [notification](../../merchant-api/webhook) about the order payment status change is sent. If the merchant reserved the item, the order can be canceled after the status changes.\n\nTime-to-live (seconds): `180 <= ttl <= 604800`\n\nTime-to-live (when generating a link in the personal account, seconds): `86400`",
"format": "int32",
"type": "integer"
}
},
"required": [
"cart",
"currencyCode",
"orderId"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/orders",
"tags": [
"order"
]
}
},
"/api/merchant/v1/orders/{order_id}": {
"get": {
"description": "Request to retrieve the order details.\n\nThe request returns the order details and the refund transactions.",
"operationId": "merchant_v1_order-get",
"parameters": [
{
"description": "Order ID on the merchant's side that was passed in the `/orders` request when creating the order.",
"in": "path",
"name": "order_id",
"required": true,
"schema": {
"maxLength": 2048,
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"delivery": {
"properties": {
"actualPrice": {
"description": "Delivery cost for the merchant",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the delivery was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"price": {
"description": "Delivery cost for the customer",
"example": "123.45",
"format": "double",
"type": "string"
},
"status": {
"default": "NEW",
"description": "Delivery status",
"enum": [
"NEW",
"ESTIMATING",
"EXPIRED",
"READY_FOR_APPROVAL",
"COLLECTING",
"PREPARING",
"DELIVERING",
"DELIVERED",
"RETURNING",
"RETURNED",
"FAILED",
"CANCELLED"
],
"type": "string"
},
"updated": {
"description": "Date and time when the delivery was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"price"
],
"type": "object"
},
"operations": {
"items": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"approvalCode": {
"description": "Code of transaction confirmation received from the processing center.",
"readOnly": true,
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"amount",
"operationId",
"operationType",
"orderId"
],
"type": "object"
},
"type": "array"
},
"order": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "List of cart items",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"finalPrice": {
"description": "Unit price including all item-level and cart-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"default": null,
"description": "Total cart cost that the customer is to pay"
}
},
"required": [
"items"
],
"type": "object"
}
],
"description": "Cart"
},
"coolingPeriodExpiresAt": {
"description": "Cooling-off period end date and time (ISO 8601)",
"format": "date-time",
"type": "string"
},
"created": {
"description": "Date and time when the order was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"isPrepayment": {
"default": false,
"description": "Flag indicating whether to process the order using the \"deferred payment\" flow.\n\nIf set to `true`, deferred payment is enabled for the order.",
"type": "boolean"
},
"merchantId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Arbitrary data transmitted at button initialization",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Total cost of the order to be paid, including refunds, delivery costs, discounts, and promo codes",
"example": "123.45",
"format": "double",
"type": "string"
},
"orderId": {
"description": "Merchant-side order ID that was passed in the [/orders](../order/merchant_v1_orders-post.md) request.",
"maxLength": 2048,
"type": "string"
},
"paymentMethod": {
"properties": {
"cardLast4": {
"maxLength": 2048,
"type": "string"
},
"cardNetwork": {
"description": "Payment system",
"enum": [
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"MAESTRO",
"VISAELECTRON",
"VISA",
"MIR",
"UNIONPAY",
"UZCARD",
"HUMOCARD",
"UNKNOWN",
"UNDEFINED",
null
],
"type": "string"
},
"methodType": {
"enum": [
"SPLIT"
],
"type": "string"
}
},
"required": [
"methodType"
],
"type": "object"
},
"paymentStatus": {
"description": "For more information, see [Operation statuses](../../../../payments/statuses).",
"enum": [
"PENDING",
"AUTHORIZED",
"CAPTURED",
"VOIDED",
"REFUNDED",
"CONFIRMED",
"PARTIALLY_REFUNDED",
"FAILED",
null
],
"type": "string",
"x-enumDescriptions": {
"AUTHORIZED": "Платеж за заказ авторизован. Средства заблокированы на счету плательщика",
"CAPTURED": "Заказ успешно оплачен. Средства списаны со счета плательщика",
"CONFIRMED": "Заказ успешно оформлен",
"FAILED": "Заказ не был успешно оплачен",
"PARTIALLY_REFUNDED": "Совершен частичный возврат средств за заказ",
"PENDING": "Ожидается оплата",
"REFUNDED": "Совершен возврат средств за заказ",
"VOIDED": "Оплата отменена. Списание средств не производилось"
}
},
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "Order cancellation reason. Applicable to the `VOIDED` and `FAILED` statuses.",
"maxLength": 2048,
"type": "string"
},
"updated": {
"description": "Date and time when the order was updated (ISO 8601)",
"format": "date-time",
"type": "string"
}
},
"required": [
"cart",
"currencyCode"
],
"type": "object"
}
},
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/orders/{order_id}",
"tags": [
"order"
]
}
},
"/api/merchant/v1/orders/{order_id}/cancel": {
"post": {
"description": "Request to cancel an order.\n\nOnly available for payments in the `AUTHORIZED` status.\nIf successful, the payment status changes to `VOIDED`.",
"operationId": "merchant_v1_cancel-post",
"parameters": [
{
"description": "Order ID on the merchant's side that was passed in the `/orders` request when creating the order.",
"in": "path",
"name": "order_id",
"required": true,
"schema": {
"maxLength": 2048,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"externalOperationId": {
"description": "Operation ID",
"maxLength": 2048,
"type": "string"
},
"reason": {
"description": "Cancellation reason",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (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"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/orders/{order_id}/cancel",
"tags": [
"order"
]
}
},
"/api/merchant/v2/orders/{order_id}/refund": {
"post": {
"description": "Request to refund an order.\n\nAsynchronous method.\n\n## Refund workflow {#refund-diagram}\n\n\n\n## Restrictions {#refund-constraints}\n\nYou can make a [full or partial payment refund](#refund-types).\n\nRefunds are available for [payments](../order/merchant_v1_order-get#basemerchantapiorder) that have one these statuses (`paymentStatus`):\n\n- `CAPTURED`: The order has been successfully paid and funds have been debited from the payer's account.\n- `PARTIALLY_REFUNDED`: A partial refund has already been issued for the order.\n\nOnce a refund is made, the `paymentStatus` changes to:\n\n- `REFUNDED` if the full amount was refunded.\n- `PARTIALLY_REFUNDED` if the cart has some items left after the refund.\n\nThe total refund amount for the current day is withheld the next business day from the partner payout for the order.\n\n**Example:** An order for som 1000 is placed at your store and a refund of som 200 is issued. On the next business day, you receive a payout of 800 som (1000 − 200).\n\n{% note warning \"You cannot process multiple refunds for the same order simultaneously.\" %}\n\nBefore sending a repeat request, ensure the current refund operation has been completed: its `status` must be `SUCCESS` or `FAIL`.\n\nOtherwise, you'll get a `409 Conflict` response with an error message saying `ANOTHER_OPERATION_IN_PROGRESS`.\n\n{% endnote %}\n\nYou can track refund status changes via [/webhook](../../merchant-api/webhook.md) notifications and using the following requests:\n\n- [/operations/\\{external_operation_id\\}/](../operation/merchant_v1_operations-get.md)\n- [/order/\\{order_id\\}/](../order/merchant_v1_order-get.md)\n\n### Here's how you can check the refund status {#refund-status-examples}\n\nUse the [/operations/\\{external_operation_id\\}/](../operation/merchant_v1_operations-get.md) method to check the status of the current refund by `externalOperationId`.\n\nIn the example below, the operation has not been completed (`\"status\": \"PENDING\"`). You can't make a repeat refund request.\n\n{% cut \"Response example\" %}\n\n```json\n{\n \"code\": 200,\n \"status\": \"success\",\n \"data\": {\n \"operation\": {\n \"operationId\": \"52b3c4a8-528b-45eb-a57f-8f808f65d28f\",\n \"operationType\": \"REFUND\",\n \"orderId\": \"OrderS-2038\",\n \"amount\": \"250.00\",\n \"pointsAmount\": null,\n \"status\": \"PENDING\", // refund in progress\n \"reason\": null,\n \"params\": { \"motive\": null, \"branch_id\": null, \"manager_id\": null },\n \"externalOperationId\": \"OrderS-2038\",\n \"created\": \"2025-03-14T14:58:45.850206+03:00\",\n \"updated\": \"2025-03-14T14:58:45.850206+03:00\"\n }\n }\n}\n```\n\n{% endcut %}\n\nUse the [/operations/{external_operation_id}/](../operation/merchant_v1_operations-get.md) method to check all the order details.\n\nIn the example below, the refund operation has been completed with `\"status\": \"SUCCESS\"` and the payment status is `\"paymentStatus\": \"PARTIALLY_REFUNDED\"`. You can make a repeat refund request.\n\n{% cut \"Response example\" %}\n\n```json\n{\n \"code\": 200,\n \"status\": \"success\",\n \"data\": {\n \"operations\": [\n {\n \"operationId\": \"52b3c4a8-528b-45eb-a57f-8f808f65d28f\",\n \"operationType\": \"REFUND\",\n \"orderId\": \"OrderS-2038\",\n \"amount\": \"250.00\",\n \"status\": \"SUCCESS\", // refund completed successfully\n \"reason\": null,\n \"params\": { \"motive\": null, \"branch_id\": null, \"manager_id\": null },\n \"externalOperationId\": \"OrderS-2038\",\n \"created\": \"2025-03-14T14:58:45.850206+03:00\",\n \"updated\": \"2025-03-14T14:58:46.084886+03:00\",\n \"approvalCode\": null\n },\n {\n \"operationId\": \"9c763cfb-dcf6-4056-be8f-ca9e2e61d772\",\n \"operationType\": \"AUTHORIZE\",\n \"orderId\": \"OrderS-2038\",\n \"amount\": \"500.00\",\n \"status\": \"SUCCESS\",\n \"reason\": null,\n \"params\": {},\n \"externalOperationId\": null,\n \"created\": \"2025-03-14T14:58:07.161667+03:00\",\n \"updated\": \"2025-03-14T14:58:07.414886+03:00\",\n \"approvalCode\": null\n }\n ],\n \"order\": {\n \"currencyCode\": \"RUB\",\n \"cart\": {\n \"items\": [\n {\n \"productId\": \"p2\",\n \"quantity\": { \"count\": \"1\", \"available\": null, \"label\": null },\n \"type\": \"UNSPECIFIED\",\n \"title\": \"Yandex Station Mini\",\n \"description\": null,\n \"total\": \"250\",\n \"subtotal\": null,\n \"discountedUnitPrice\": \"250\",\n \"unitPrice\": null,\n \"measurements\": null,\n \"finalPrice\": \"250\",\n \"pointsAmount\": null,\n \"features\": null\n }\n ],\n \"total\": { \"amount\": \"250\", \"pointsAmount\": null, \"label\": null },\n \"cartId\": \"1eed9a9827e68ba8981d9961c1237624fabc19cda05044b574e06302e83c7549\",\n \"externalId\": null,\n \"coupons\": null,\n \"discounts\": null,\n \"measurements\": null\n },\n \"merchantId\": \"76cc0f5c-91c4-40f2-9794-64a64c3c6011\",\n \"orderAmount\": \"250.00\",\n \"orderId\": \"OrderS-2038\",\n \"paymentMethod\": { \"methodType\": \"CARD\", \"cardLast4\": \"0412\", \"cardNetwork\": \"MASTERCARD\" },\n \"shippingMethod\": null,\n \"metadata\": null,\n \"created\": \"2025-03-14T14:58:03.699930+03:00\",\n \"updated\": \"2025-03-14T14:58:46.084886+03:00\",\n \"paymentStatus\": \"PARTIALLY_REFUNDED\", // payment partially refunded\n \"reason\": null,\n \"paymentUrl\": \"https://sandbox.pay.yandex.uz/l/I1RnP9\",\n \"isPrepayment\": false,\n \"splitCode\": null\n },\n \"delivery\": null\n }\n}\n```\n\n{% endcut %}\n\n## Refund types {#refund-types}\n\nYou can make full and partial refunds.\n\nTo make a **full** refund, only pass the `refundAmount` parameter that is equal to the order amount.\n\nTo make a **partial** refund, pass the `refundAmount` parameter that is equal to the refund amount and add the cart of items or services provided. You can create a cart in one of the following ways:\n\n- Method 1: Specify the cart status after the refund.\n\n Use the `targetCart` field to describe the final cart the customer will have after the refund is made. If the field is omitted, it's considered that the entire cart is refunded.\n\n The `targetShipping` field is only applicable to Yandex Pay Checkout.\n In all other cases, leave the field empty. If the field is omitted, it's considered that the delivery cost is refunded in full.\n\n- Method 2: Specify the items to be refunded.\n\n Use the `refundCart` field to specify the number of items to be refunded or the amount\n to decrease the cost of a specific item by. If the field is empty, the refund is made for the entire cart.\n\n{% note info %}\n\nIf you use the `refundCart` field, specify the `externalOperationId` value. It's used as the idempotency key to prevent the risk of repeat refunds.\n\n{% endnote %}\n\n## Refund examples {#refund-examples}\n\nLet's take an example of an order with the `orderId = Order-123` and the following cart:\n\n```json\n{\n \"items\": [\n {\n \"productId\": \"id-1\",\n \"price\": \"50\",\n \"title\": \"Ballpoint pen\",\n \"quantity\": {\n \"count\": \"10\"\n }\n },\n {\n \"productId\": \"id-2\",\n \"price\": \"200\",\n \"title\": \"Notepad\",\n \"quantity\": {\n \"count\": \"2\"\n }\n }\n ]\n}\n```\n\n### Full refund {#refund-examples-full}\n\n{% list tabs %}\n\n- httpie\n\n ```(bash)\n http POST https://sandbox.pay.yandex.uz/api/merchant/v2/orders/Order-123/refund \\\n \"Authorization: Api-Key ${API_KEY}\" 'refundAmount:=\"900.00\"'\n ```\n\n{% endlist %}\n\n### Partial refund {#refund-examples-partial}\n\n#### Returning a number of items {#single-item}\n\nSuppose that two ballpoint pens need to be refunded. This is done using the following request:\n\n{% list tabs %}\n\n- httpie\n\n ```(bash)\n http POST https://sandbox.pay.yandex.uz/api/merchant/v2/orders/Order-123/refund \\\n \"Authorization: Api-Key ${API_KEY}\" \\\n 'targetCart[items][0]:={\"productId\": \"id-1\", \"quantityCount\": \"8\"}' \\\n 'targetCart[items][1]:={\"productId\": \"id-2\", \"quantityCount\": \"2\"}' \\\n 'refundAmount:=\"100.00\"'\n ```\n\n{% endlist %}\n\nIn this example:\n\n- The number of ballpoint pens decreases by two — from 10 to 8 units.\n- The `price` field is skipped in the request but can be specified if needed.\n- `quantityCount` of the notepad item remains unchanged and could be omitted.\n\n#### Refunding part of the amount {#price-update}\n\nLet's say a refund of som 30 is required for each notepad. This is achieved by reducing the item price.\n\n{% list tabs %}\n\n- httpie\n\n ```(bash)\n http POST https://sandbox.pay.yandex.uz/api/merchant/v2/orders/Order-123/refund \\\n \"Authorization: Api-Key ${API_KEY}\" \\\n 'targetCart[items]:=[{\"productId\": \"id-1\"}, {\"productId\": \"id-2\", \"price\": \"170\"}]' \\\n 'refundAmount:=\"60.00\"'\n ```\n\n{% endlist %}\n\nIn this example:\n\n- The notepad price decreases by 30 som — from 200 to 170 som.\n- As a result, 60 som is refunded because there were two notepads.\n- The `quantityCount` values are not specified but can be included with their original values.\n\n#### Refund with the number of items to return specified {#single-item-refund-cart}\n\nSuppose that two ballpoint pens need to be refunded. This is done using the following request:\n\n{% list tabs %}\n\n- httpie\n\n ```(bash)\n http POST https://sandbox.pay.yandex.uz/api/merchant/v2/orders/Order-123/refund \\\n \"Authorization: Api-Key ${API_KEY}\" \\\n 'refundCart[items][0]:={\"productId\": \"id-1\", \"quantityCount\": \"2\"}' \\\n 'refundAmount:=\"100.00\"'\n ```\n\n{% endlist %}\n\nIn this example:\n\n- The number of ballpoint pens decreases by two — from 10 to 8 units.\n- The `price` field is omitted in the request but can be specified if needed.\n\n#### Refund specifying the portion of the item price to refund {#price-update-refund-cart}\n\nLet's say a refund of som 30 is required for each notepad. This is achieved by reducing the item price.\n\n{% list tabs %}\n\n- httpie\n\n ```(bash)\n http POST https://sandbox.pay.yandex.uz/api/merchant/v2/orders/Order-123/refund \\\n \"Authorization: Api-Key ${API_KEY}\" \\\n 'refundCart[items]:=[{\"productId\": \"id-1\"}, {\"productId\": \"id-2\", \"price\": \"30\"}]' \\\n 'refundAmount:=\"60.00\"'\n ```\n\n{% endlist %}\n\nIn this example:\n\n- The notepad price decreases by 30 — from 200 som to 170 som.\n- As a result, 60 som is refunded because there were two notepads.\n- The `quantityCount` values are not specified but can be included with their original values.",
"operationId": "merchant_v2_refund-post",
"parameters": [
{
"description": "Order ID on the merchant's side that was passed in the `/orders` request when creating the order.",
"in": "path",
"name": "order_id",
"required": true,
"schema": {
"maxLength": 2048,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"branchId": {
"description": "ID of the point of sale",
"maxLength": 2048,
"type": "string"
},
"externalOperationId": {
"description": "Refund operation ID in the merchant system. Make sure it's unique.\n\nPass this parameter to track the refund operation status via the [operations/{external_operation_id}](../operation/merchant_v1_operations-get) method.\n\nIf the operation is not completed (is either in progress or stopped), repeated refund requests with the same arguments and `externalOperationId` are idempotent — the response will return the same operation. Otherwise, an error is returned.\n\nIf the refund process is launched successfully, calling the refund method with the same `externalOperationId` again will return an error with the `reasonCode: \"DUPLICATE_EXTERNAL_OPERATION_ID\"`.",
"maxLength": 2048,
"type": "string"
},
"managerId": {
"description": "Manager ID",
"maxLength": 2048,
"type": "string"
},
"motive": {
"description": "Refund reason",
"maxLength": 2048,
"type": "string"
},
"refundAmount": {
"description": "Refund amount.",
"example": "123.45",
"format": "double",
"type": "string"
},
"refundCart": {
"allOf": [
{
"properties": {
"items": {
"items": {
"properties": {
"price": {
"description": "Unit price after the operation.\nRequired if the unit price is reduced as a result of the operation.\nUseful when refunding part of the amount or when confirming the order.\nIf not specified, the price is assumed to remain unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
},
"productId": {
"description": "Cart item ID at the time the order was created.\nIf you pass an ID that was not present in the initial cart, an error occurs.",
"maxLength": 2048,
"type": "string"
},
"quantityCount": {
"description": "Quantity of items for the refund operation.\n\nThe value depends on the cart used:\n\n- If it's `targetCart`, the `quantityCount` field shows the number of items remaining after the refund (if there are 5 items and 3 are specified, 2 are refunded).\n- If it's `refundCart`, the `quantityCount` field shows the number of items to be refunded (if there are 5 items and 3 are specified, 3 are refunded).\n\nIf the field is empty, the number of items remains unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Specifies the cart items to be refunded.\nCan't be specified concurrently with the `targetCart` field value.\nWe recommend passing this parameter value along with the `externalOperationId` value because it's used as the idempotency key."
},
"targetCart": {
"allOf": [
{
"properties": {
"items": {
"items": {
"properties": {
"price": {
"description": "Unit price after the operation.\nRequired if the unit price is reduced as a result of the operation.\nUseful when refunding part of the amount or when confirming the order.\nIf not specified, the price is assumed to remain unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
},
"productId": {
"description": "Cart item ID at the time the order was created.\nIf you pass an ID that was not present in the initial cart, an error occurs.",
"maxLength": 2048,
"type": "string"
},
"quantityCount": {
"description": "Quantity of items for the refund operation.\n\nThe value depends on the cart used:\n\n- If it's `targetCart`, the `quantityCount` field shows the number of items remaining after the refund (if there are 5 items and 3 are specified, 2 are refunded).\n- If it's `refundCart`, the `quantityCount` field shows the number of items to be refunded (if there are 5 items and 3 are specified, 3 are refunded).\n\nIf the field is empty, the number of items remains unchanged.",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Shows the final cart status after the refund.\nIf the field is omitted, it's considered that the cart is refunded in full. Can't be specified concurrently with the `refundCart` field value."
},
"targetShipping": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cost of delivery after the operation is completed",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"type": "object"
}
],
"description": "Applicable to Yandex Pay Checkout only. In all other cases, leave the field empty.\n\nShows the final delivery status after the refund.\nIf the field is omitted or is `null`, it's considered that the delivery cost is refunded in full."
}
},
"required": [
"refundAmount"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (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"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v2/orders/{order_id}/refund",
"tags": [
"order"
]
}
},
"/api/merchant/v1/orders/{order_id}/capture": {
"post": {
"description": "Request to debit funds for the order.\n\nDebiting of locked funds. Only available for payments in the `AUTHORIZED` status.\nIf the request result is successful, the payment status changes to `CAPTURED`.\n\nIf the authorized amount is smaller than the original amount, the remaining part of the payment will be refunded.\nIn this case, pass the final cart of products and services provided.\nThe final cart must be based on the current cart,\nexcluding refunded items.",
"operationId": "merchant_v1_capture-post",
"parameters": [
{
"description": "The merchant-side order ID returned in response to /orders.",
"in": "path",
"name": "order_id",
"required": true,
"schema": {
"maxLength": 2048,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Final cart"
},
"externalOperationId": {
"description": "Operation ID",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Amount to be debited. If not specified, the total amount of the passed cart items will be debited",
"example": "123.45",
"format": "double",
"type": "string"
},
"shipping": {
"allOf": [
{
"properties": {
"amount": {
"description": "It shouldn't include more than two decimal digits.\nFor example: 1.12, 5.1, 10, or 11.00.",
"example": "123.45",
"format": "double",
"type": "string"
},
"methodType": {
"enum": [
"DIRECT",
"PICKUP",
"COURIER",
"YANDEX_DELIVERY"
],
"type": "string"
}
},
"required": [
"amount",
"methodType"
],
"type": "object"
}
],
"description": "Final delivery method."
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (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"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/orders/{order_id}/capture",
"tags": [
"order"
]
}
},
"/api/merchant/v1/orders/{order_id}/rollback": {
"post": {
"description": "Request to cancel an order.\n\nAvailable for payments in any status.\nDisables further payment for the order and, if the payment has already been made,\nfully refunds the customer.\nIf successful, the payment status changes to `FAILED`.",
"operationId": "merchant_v1_rollback-post",
"parameters": [
{
"description": "Order ID on the merchant's side that was passed in the `/orders` request when creating the order.",
"in": "path",
"name": "order_id",
"required": true,
"schema": {
"maxLength": 2048,
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/orders/{order_id}/rollback",
"tags": [
"order"
]
}
},
"/api/merchant/v1/orders/{order_id}/submit": {
"post": {
"description": "Request for Split payment confirmation in the event of payment on delivery.\n\nAvailable for payments in the `CONFIRMED` status. If the request result is successful, the status changes to `CAPTURED`.\n\nIf the cart items at the order confirmation stage differ from those at the order placement stage,\npass new values for the `cart` and `orderAmount` fields.",
"operationId": "merchant_v1_submit-post",
"parameters": [
{
"description": "The merchant-side order ID returned in response to /orders.",
"in": "path",
"name": "order_id",
"required": true,
"schema": {
"maxLength": 2048,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"cartId": {
"description": "Cart ID on the Yandex side",
"maxLength": 2048,
"type": "string"
},
"coupons": {
"description": "Coupons applied to the cart",
"items": {
"properties": {
"description": {
"description": "Coupon description",
"example": "Скидка 3%",
"maxLength": 2048,
"type": "string"
},
"status": {
"enum": [
"VALID",
"INVALID",
"EXPIRED",
null
],
"type": "string"
},
"value": {
"description": "Coupon code",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"type": "array"
},
"discounts": {
"description": "Discounts applied to the cart",
"items": {
"properties": {
"amount": {
"description": "Discount amount",
"example": "123.45",
"format": "double",
"type": "string"
},
"description": {
"description": "Text description",
"maxLength": 2048,
"type": "string"
},
"discountId": {
"description": "Discount identifier in the merchant system",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"amount",
"description",
"discountId"
],
"type": "object"
},
"type": "array"
},
"externalId": {
"description": "Merchant-side cart identifier",
"maxLength": 2048,
"type": "string"
},
"items": {
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"pointsDisabled": {
"default": false,
"description": "Unavailable in Uzbekistan.",
"type": "boolean"
},
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
],
"description": "Product dimensions and weight. Required for the `PHYSICAL` product type"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product ID in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique ID that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total item price including item-level discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"type": {
"default": "UNSPECIFIED",
"description": "Product type. Important for integrating with delivery services",
"enum": [
"PHYSICAL",
"DIGITAL",
"UNSPECIFIED"
],
"type": "string"
},
"unitPrice": {
"description": "Full unit price excluding discounts",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity"
],
"type": "object"
},
"type": "array"
},
"measurements": {
"allOf": [
{
"properties": {
"height": {
"description": "Height, in meters",
"format": "float",
"type": "number"
},
"length": {
"description": "Length, in meters",
"format": "float",
"type": "number"
},
"weight": {
"description": "Weight, in kilograms",
"format": "float",
"type": "number"
},
"width": {
"description": "Width, in meters",
"format": "float",
"type": "number"
}
},
"required": [
"height",
"length",
"weight",
"width"
],
"type": "object"
}
]
},
"total": {
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Final cart"
},
"externalOperationId": {
"description": "Operation ID in the merchant's system",
"maxLength": 2048,
"type": "string"
},
"orderAmount": {
"description": "Total amount of the order. Equal to `cart.total.amount`.\n\nThe field is required if `cart` is passed.",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"externalOperationId"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (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"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/orders/{order_id}/submit",
"tags": [
"order"
]
}
},
"/api/merchant/v1/operations/{external_operation_id}": {
"get": {
"description": "Request to get details about the payment authorization, debiting, refund, or cancellation operations.",
"operationId": "merchant_v1_operations-get",
"parameters": [
{
"description": "Operation ID on the merchant side",
"in": "path",
"name": "external_operation_id",
"required": true,
"schema": {
"maxLength": 2048,
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operation": {
"properties": {
"amount": {
"description": "Transaction amount in a fiat currency",
"example": "123.45",
"format": "double",
"type": "string"
},
"created": {
"description": "Date and time when the operation was created (ISO 8601)",
"format": "date-time",
"type": "string"
},
"externalOperationId": {
"description": "Operation ID on the merchant side",
"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": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"type": "string"
},
"reason": {
"description": "Error cause",
"maxLength": 2048,
"type": "string"
},
"status": {
"default": "PENDING",
"enum": [
"PENDING",
"SUCCESS",
"FAIL"
],
"type": "string"
},
"updated": {
"description": "Date and time when the operation was updated (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"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/operations/{external_operation_id}",
"tags": [
"operation"
]
}
},
"/api/merchant/v1/subscriptions": {
"post": {
"description": "Request for subscription creation.\n\nUsed to create a subscription and obtain a link to start it.",
"operationId": "merchant_v1_subscriptions-post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"cart": {
"allOf": [
{
"properties": {
"externalId": {
"description": "Cart ID passed by the merchant",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Cart items that the customer pays for.",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Number of Plus points\n\nThe field is read-only. Any passed values are ignored.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product id in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique id that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total price per item with item discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Total price per product unit without discount",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Final order cost."
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Cart"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"futureWriteOffAmount": {
"description": "Amount to be debited in the future",
"example": "123.45",
"format": "double",
"type": "string"
},
"intervalCount": {
"description": "Number of subscription periods in time units specified in `intervalUnit`.\n\nFor example, for a 6-month subscription, specify: `intervalUnit: 'MONTH'`, `intervalCount: 6`.\n\nRequired if `isBinding=True` is not specified.",
"example": "6",
"format": "int32",
"type": "integer"
},
"intervalUnit": {
"description": "Time unit of the subscription frequency.\n\nRequired if `isBinding=True` is not specified.",
"enum": [
"SECOND",
"DAY",
"WEEK",
"MONTH",
"YEAR",
null
],
"type": "string"
},
"isBinding": {
"default": false,
"description": "Allows linking the user's card with no items added to the cart.\n\nIf the first transaction is only for card binding, pass `isBinding: true` in the request.\n\nIn this scenario, you don't need to pass the cart or subscription period.",
"type": "boolean"
},
"metadata": {
"description": "Arbitrary order data for internal use",
"maxLength": 2048,
"type": "string"
},
"orderId": {
"description": "Order ID on the merchant side (it should be unique). Further interaction on the payment request will be carried out using this ID. The ID will also be used at reconciliation",
"maxLength": 2048,
"type": "string"
},
"orderSource": {
"default": null,
"description": "Indicates where order creation was initialized\n\nUsed for subsequent analysis\n\n---\n\n**WEBSITE**: The button is placed on a website. A payment link is generated after certain user actions (clicking the button) on the website\n\n**APP**: The button is placed in a mobile app. A payment link is generated after certain user actions (tapping the button) in the app\n\n**CRM**: A payment link is generated by a manager in the CRM system or another admin panel\n\n**CASH_REGISTER**: A payment link is generated to be displayed in the offline cash register\n\n**CMS_PLUGIN**: A payment link is generated in the CMS plugin\n\n**TV**: A payment link is generated to be displayed on a TV platform",
"enum": [
"WEBSITE",
"APP",
"CRM",
"CASH_REGISTER",
"CMS_PLUGIN",
"TV"
],
"type": "string"
},
"purpose": {
"description": "Purpose of payment",
"maxLength": 1000,
"type": "string"
},
"redirectUrls": {
"allOf": [
{
"properties": {
"onAbort": {
"description": "Link to redirect the user on payment cancellation. Payment can be canceled by the user in the payment form.",
"maxLength": 2048,
"type": "string"
},
"onError": {
"description": "The field is required for online stores only. A link to redirect the user in case of a payment error or TTL expiry for a payment link",
"maxLength": 2048,
"type": "string"
},
"onSuccess": {
"description": "The field is required for online stores only. Link to redirect the user on payment success.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"onError",
"onSuccess"
],
"type": "object"
}
],
"description": "Links for redirecting the user from the payment form. Required for online stores."
},
"title": {
"description": "Subscription name",
"maxLength": 30,
"type": "string"
},
"trialCount": {
"description": "Number of subscription trial periods specified in `trialUnit`.\n\nFor example, for a subscription with a 7-day trial period, specify: `trialUnit: 'DAY'`, `trialCount: 7`.",
"format": "int32",
"type": "integer"
},
"trialEndAt": {
"description": "Trial period end date. Mutually exclusive with the `trial_unit` + `trial_count` fields.",
"format": "date-time",
"type": "string"
},
"trialUnit": {
"description": "Time unit of the trial subscription.",
"enum": [
"SECOND",
"DAY",
"WEEK",
"MONTH",
"YEAR",
null
],
"type": "string"
},
"ttl": {
"default": 1800,
"description": "Order's time to live (in seconds)\n\n`180 <= ttl <= 604800`",
"format": "int32",
"type": "integer"
}
},
"required": [
"currencyCode",
"orderId"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"paymentUrl": {
"description": "Link to paying for the order",
"maxLength": 2048,
"type": "string"
},
"subscriptionId": {
"description": "Subscription ID",
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"paymentUrl",
"subscriptionId"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/subscriptions",
"tags": [
"subscriptions",
"nobuild",
"noindex"
]
}
},
"/api/merchant/v1/subscriptions/recur": {
"post": {
"description": "Request for recurring subscription charge.\n\nUsed for automatic charges to the account or card linked to the subscription.\nTo debit funds, pass the order ID, cart, debit amount, and ID of the initial order\nnumber used when creating the subscription.",
"operationId": "merchant_v1_subscriptions_recur-post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"amount": {
"description": "Amount to be debited",
"example": "123.45",
"format": "double",
"type": "string"
},
"cart": {
"allOf": [
{
"properties": {
"externalId": {
"description": "Cart ID passed by the merchant",
"maxLength": 2048,
"type": "string"
},
"items": {
"description": "Cart items that the customer pays for.",
"items": {
"properties": {
"description": {
"description": "Product description",
"maxLength": 2048,
"type": "string"
},
"discountedUnitPrice": {
"description": "Price per product unit with discount per item",
"example": "123.45",
"format": "double",
"type": "string"
},
"features": {
"allOf": [
{
"properties": {
"tariffModifier": {
"description": "Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.",
"enum": [
"VERY_LOW",
"LOW",
"MEDIUM",
"HIGH",
"VERY_HIGH",
null
],
"type": "string"
}
},
"type": "object"
}
],
"description": "Product promo parameters"
},
"pointsAmount": {
"description": "Number of Plus points\n\nThe field is read-only. Any passed values are ignored.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
},
"productId": {
"description": "Product id in the merchant system. Make sure that each `productId` in the request parameters is unique.",
"maxLength": 2048,
"type": "string"
},
"quantity": {
"allOf": [
{
"properties": {
"available": {
"description": "Maximum available product quantity",
"example": "123.45",
"format": "double",
"type": "string"
},
"count": {
"description": "Product quantity in the order",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"count"
],
"type": "object"
}
],
"description": "Product quantity in the order"
},
"skuId": {
"description": "Unique id that describes a product range unit. Required when applying individual rates.",
"maxLength": 2048,
"type": "string"
},
"subtotal": {
"description": "Total price per item without discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"title": {
"description": "Product name",
"maxLength": 2048,
"type": "string"
},
"total": {
"description": "Total price per item with item discount",
"example": "123.45",
"format": "double",
"type": "string"
},
"unitPrice": {
"description": "Total price per product unit without discount",
"example": "123.45",
"format": "double",
"type": "string"
}
},
"required": [
"productId",
"quantity",
"title",
"total"
],
"type": "object"
},
"type": "array"
},
"total": {
"allOf": [
{
"properties": {
"amount": {
"description": "Cart cost with all discounts",
"example": "123.45",
"format": "double",
"type": "string"
},
"pointsAmount": {
"description": "Unavailable in Uzbekistan.",
"example": "123.45",
"format": "double",
"readOnly": true,
"type": "string"
}
},
"required": [
"amount"
],
"type": "object"
}
],
"description": "Final order cost."
}
},
"required": [
"items",
"total"
],
"type": "object"
}
],
"description": "Cart"
},
"currencyCode": {
"description": "Three-letter code of the order currency code (ISO 4217)",
"enum": [
"RUB",
"UZS"
],
"maxLength": 2048,
"type": "string"
},
"metadata": {
"description": "Arbitrary order data for internal use",
"maxLength": 2048,
"type": "string"
},
"orderId": {
"description": "The order ID on the merchant side (it should be unique).",
"maxLength": 2048,
"type": "string"
},
"parentOrderId": {
"description": "ID of the initial order",
"maxLength": 2048,
"type": "string"
},
"purpose": {
"description": "Purpose of payment",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"amount",
"cart",
"currencyCode",
"orderId",
"parentOrderId"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"operationId": {
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"operationId"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/subscriptions/recur",
"tags": [
"subscriptions",
"nobuild",
"noindex"
]
}
},
"/api/merchant/v1/subscriptions/{customer_subscription_id}": {
"get": {
"description": "Request to retrieve subscription information.\n\nReturns the subscription ID and status and the linked payment method.",
"operationId": "merchant_v1_customer_subscription-get",
"parameters": [
{
"description": "Subscription ID",
"in": "path",
"name": "customer_subscription_id",
"required": true,
"schema": {
"maxLength": 2048,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"check_card_active": {
"description": "Allows checking if the card is linked",
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"default": 200
},
"data": {
"properties": {
"cancelledAt": {
"description": "Subscription cancellation time",
"format": "date-time",
"type": "string"
},
"customerSubscriptionId": {
"description": "Subscription ID",
"format": "uuid",
"maxLength": 2048,
"type": "string"
},
"isCardActive": {
"description": "Linked card's status",
"type": "boolean"
},
"nextWriteOff": {
"description": "Date of next debit",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Subscription type",
"enum": [
"NEW",
"ACTIVE",
"CANCELLED",
"EXPIRED"
],
"type": "string"
},
"subscriptionPlanId": {
"description": "Subscription plan ID",
"format": "uuid",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"status",
"subscriptionPlanId"
],
"type": "object"
},
"status": {
"default": "success",
"enum": [
"success"
],
"type": "string"
}
},
"type": "object"
}
}
},
"description": ""
}
},
"security": [
{
"ApiKey": []
}
],
"summary": "/v1/subscriptions/{customer_subscription_id}",
"tags": [
"subscriptions",
"nobuild",
"noindex"
]
}
}
},
"security": [
{}
],
"servers": [
{
"description": "Production",
"url": "https://pay.yandex.uz"
},
{
"description": "Sandbox",
"url": "https://sandbox.pay.yandex.uz"
}
]
}
Was the article helpful?
Previous
Next