/v1/orders/{order_id}/submit

Запрос на подтверждение оплаты для Сплита с оплатой при получении.

Доступно для платежей в статусе CONFIRMED. При успешном результате запроса статус изменится на CAPTURED.

Если состав корзины на этапе подтверждения заказа отличается от состава корзины на этапе оформления, передайте новые значения для полей cart и orderAmount.

Request

POST

https://pay.yandex.uz/api/merchant/v1/orders/{order_id}/submit

Production

POST

https://sandbox.pay.yandex.uz/api/merchant/v1/orders/{order_id}/submit

Sandbox

Path parameters

Name

Description

order_id

Type: string

ID заказа на стороне продавца, который был передан в ответе на /orders.

Max length: 2048

Example: ``

Body

application/json

{
  "cart": {
    "cartId": "example",
    "coupons": [
      {
        "description": "Скидка 3%",
        "status": "VALID",
        "value": "example"
      }
    ],
    "discounts": [
      {
        "amount": "123.45",
        "description": "example",
        "discountId": "example"
      }
    ],
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "features": null,
        "measurements": null,
        "productId": "example",
        "quantity": null,
        "skuId": "example",
        "subtotal": "123.45",
        "title": "example",
        "total": "123.45",
        "type": "UNSPECIFIED",
        "unitPrice": "123.45"
      }
    ],
    "measurements": {
      "height": 0.5,
      "length": 0.5,
      "weight": 0.5,
      "width": 0.5
    },
    "total": {
      "amount": "123.45"
    }
  },
  "externalOperationId": "example",
  "orderAmount": "123.45"
}

Name	Description
externalOperationId	Type: string Идентификатор операции в системе продавца Max length: `2048` Example: `example`
cart	All of 1 type Type: CartWithRequiredTotalWithoutFinalPrice Example { "cartId": "example", "coupons": [ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "123.45", "features": { "pointsDisabled": false, "tariffModifier": "VERY_LOW" }, "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "productId": "example", "quantity": { "available": "123.45", "count": "123.45" }, "skuId": "example", "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": { "amount": "123.45" } } Итоговая корзина Example { "cartId": "example", "coupons": [ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "123.45", "features": null, "measurements": null, "productId": "example", "quantity": null, "skuId": "example", "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": { "amount": "123.45" } }
orderAmount	Type: string<double> Итоговая сумма заказа. Равна `cart.total.amount`. Является обязательным полем, если передается `cart`. Example: `123.45`

Coupon

Name	Description
value	Type: string Код купона Max length: `2048` Example: `example`
description	Type: string Описание купона Max length: `2048` Example: `Скидка 3%`
status	Type: string Enum: `VALID`, `INVALID`, `EXPIRED`, `null` Example: `VALID`

Example

{
  "description": "Скидка 3%",
  "status": "VALID",
  "value": "example"
}

Discount

Name	Description
amount	Type: string<double> Сумма скидки Example: `123.45`
description	Type: string Текстовое описание Max length: `2048` Example: `example`
discountId	Type: string Идентификатор скидки в системе продавца Max length: `2048` Example: `example`

Example

{
  "amount": "123.45",
  "description": "example",
  "discountId": "example"
}

CartItemFeatures

Name

Description

pointsDisabled

Type: boolean

Недоступно в Узбекистане.

Default: false

tariffModifier

Type: string

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

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

Example: VERY_LOW

Example

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

Measurements

Name	Description
height	Type: number Высота, в метрах
length	Type: number Длина, в метрах
weight	Type: number Вес, в килограммах
width	Type: number Ширина, в метрах

Example

{
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

ItemQuantity

Name

Description

count

Type: string<double>

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

Example: 123.45

available

Type: string<double>

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

Example: 123.45

Example

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

CartItemWithoutFinalPriceCamelCase

Name	Description
productId	Type: string ID товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным Max length: `2048` Example: `example`
quantity	All of 1 type Type: ItemQuantity Example `{ "available": "123.45", "count": "123.45" }` Количество товара в заказе Example `{ "available": "123.45", "count": "123.45" }`
description	Type: string Описание товара Max length: `2048` Example: `example`
discountedUnitPrice	Type: string<double> Цена за единицу товара с учетом скидок на позицию Example: `123.45`
features	All of 1 type Type: CartItemFeatures Example `{ "pointsDisabled": false, "tariffModifier": "VERY_LOW" }` Промо параметры товара Example `{ "pointsDisabled": false, "tariffModifier": "VERY_LOW" }`
measurements	All of 1 type Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }` Размеры и вес товара. Обязательно для товара типа `PHYSICAL` Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
skuId	Type: string Уникальный ID, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа. Max length: `2048` Example: `example`
subtotal	Type: string<double> Суммарная цена за позицию без учета скидок Example: `123.45`
title	Type: string Наименование товара Max length: `2048` Example: `example`
total	Type: string<double> Суммарная цена за позицию с учетом скидок на позицию Example: `123.45`
type	Type: string Тип товара. Важен для интеграции с доставками Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Полная цена за единицу товара без учета скидки Example: `123.45`

Example

{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "pointsDisabled": false,
    "tariffModifier": "VERY_LOW"
  },
  "measurements": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

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

Example: 123.45

Example

{
  "amount": "123.45"
}

CartWithRequiredTotalWithoutFinalPrice

Name	Description
items	Type: CartItemWithoutFinalPriceCamelCase[] Example `[ { "description": "example", "discountedUnitPrice": "123.45", "features": { "pointsDisabled": false, "tariffModifier": "VERY_LOW" }, "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "productId": "example", "quantity": { "available": "123.45", "count": "123.45" }, "skuId": "example", "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ]`
total	Type: CartTotal Example `{ "amount": "123.45" }`
cartId	Type: string Идентификатор корзины на стороне Яндекса Max length: `2048` Example: `example`
coupons	Type: Coupon[] Купоны, примененные к корзине Example `[ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Скидки, примененные к корзине Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Идентификатор корзины на стороне продавца Max length: `2048` Example: `example`
measurements	Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`

Example

{
  "cartId": "example",
  "coupons": [
    {
      "description": "Скидка 3%",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": {
    "amount": "123.45"
  }
}

Responses

200 OK

Body

application/json

{
  "code": 200,
  "data": {
    "operation": {
      "amount": "123.45",
      "created": "2025-01-01T00:00:00Z",
      "externalOperationId": "example",
      "operationId": "123e4567-e89b-12d3-a456-426614174000",
      "operationType": "AUTHORIZE",
      "orderId": "example",
      "params": {},
      "pointsAmount": "123.45",
      "reason": "example",
      "status": "PENDING",
      "updated": "2025-01-01T00:00:00Z"
    }
  },
  "status": "success"
}

Name	Description
code	Type: unknown Default: `200`
data	Type: OperationResponseData Example `{ "operation": { "amount": "123.45", "created": "2025-01-01T00:00:00Z", "externalOperationId": "example", "operationId": "123e4567-e89b-12d3-a456-426614174000", "operationType": "AUTHORIZE", "orderId": "example", "params": {}, "pointsAmount": "123.45", "reason": "example", "status": "PENDING", "updated": "2025-01-01T00:00:00Z" } }`
status	Type: string Default: `success` Const: `success`

CartItemWithoutFinalPriceCamelCase

Name	Description
productId	Type: string ID товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным Max length: `2048` Example: `example`
quantity	All of 1 type Type: ItemQuantity Example `{ "available": "123.45", "count": "123.45" }` Количество товара в заказе Example `{ "available": "123.45", "count": "123.45" }`
description	Type: string Описание товара Max length: `2048` Example: `example`
discountedUnitPrice	Type: string<double> Цена за единицу товара с учетом скидок на позицию Example: `123.45`
features	All of 1 type Type: CartItemFeatures Example `{ "pointsDisabled": false, "tariffModifier": "VERY_LOW" }` Промо параметры товара Example `{ "pointsDisabled": false, "tariffModifier": "VERY_LOW" }`
measurements	All of 1 type Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }` Размеры и вес товара. Обязательно для товара типа `PHYSICAL` Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
pointsAmount	Type: string<double> Недоступно в Узбекистане. Example: `123.45`
skuId	Type: string Уникальный ID, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа. Max length: `2048` Example: `example`
subtotal	Type: string<double> Суммарная цена за позицию без учета скидок Example: `123.45`
title	Type: string Наименование товара Max length: `2048` Example: `example`
total	Type: string<double> Суммарная цена за позицию с учетом скидок на позицию Example: `123.45`
type	Type: string Тип товара. Важен для интеграции с доставками Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Полная цена за единицу товара без учета скидки Example: `123.45`

Example

{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "pointsDisabled": false,
    "tariffModifier": "VERY_LOW"
  },
  "measurements": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "pointsAmount": "123.45",
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

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

Example: 123.45

pointsAmount

Type: string<double>

Недоступно в Узбекистане.

Example: 123.45

Example

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

CartWithRequiredTotalWithoutFinalPrice

Name	Description
items	Type: CartItemWithoutFinalPriceCamelCase[] Example `[ { "description": "example", "discountedUnitPrice": "123.45", "features": { "pointsDisabled": false, "tariffModifier": "VERY_LOW" }, "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "pointsAmount": "123.45", "productId": "example", "quantity": { "available": "123.45", "count": "123.45" }, "skuId": "example", "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ]`
total	Type: CartTotal Example `{ "amount": "123.45", "pointsAmount": "123.45" }`
cartId	Type: string Идентификатор корзины на стороне Яндекса Max length: `2048` Example: `example`
coupons	Type: Coupon[] Купоны, примененные к корзине Example `[ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Скидки, примененные к корзине Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Идентификатор корзины на стороне продавца Max length: `2048` Example: `example`
measurements	Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`

Example

{
  "cartId": "example",
  "coupons": [
    {
      "description": "Скидка 3%",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "pointsAmount": "123.45",
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": {
    "amount": "123.45",
    "pointsAmount": "123.45"
  }
}

Operation

Name	Description
amount	Type: string<double> Сумма операции в фиатной валюте Example: `123.45`
operationId	Type: string<uuid> Max length: `2048` Example: `123e4567-e89b-12d3-a456-426614174000`
operationType	Type: string Enum: `AUTHORIZE`, `BIND_CARD`, `REFUND`, `CAPTURE`, `VOID`, `RECURRING`, `PREPAYMENT`, `SUBMIT`
orderId	Type: string Max length: `2048` Example: `example`
created	Type: string<date-time> Дата и время создания операции (ISO 8601) Example: `2025-01-01T00:00:00Z`
externalOperationId	Type: string Идентификатор операции на стороне продавца Max length: `2048` Example: `example`
params	Type: object Example `{}`
pointsAmount	Type: string<double> Недоступно в Узбекистане. Example: `123.45`
reason	Type: string Причина ошибки Max length: `2048` Example: `example`
status	Type: string Default: `PENDING` Enum: `PENDING`, `SUCCESS`, `FAIL`
updated	Type: string<date-time> Дата и время обновления операции (ISO 8601) Example: `2025-01-01T00:00:00Z`

Example

{
  "amount": "123.45",
  "created": "2025-01-01T00:00:00Z",
  "externalOperationId": "example",
  "operationId": "123e4567-e89b-12d3-a456-426614174000",
  "operationType": "AUTHORIZE",
  "orderId": "example",
  "params": {},
  "pointsAmount": "123.45",
  "reason": "example",
  "status": "PENDING",
  "updated": "2025-01-01T00:00:00Z"
}

OperationResponseData

Name

Description

operation

Type: Operation

Example

{
  "amount": "123.45",
  "created": "2025-01-01T00:00:00Z",
  "externalOperationId": "example",
  "operationId": "123e4567-e89b-12d3-a456-426614174000",
  "operationType": "AUTHORIZE",
  "orderId": "example",
  "params": {},
  "pointsAmount": "123.45",
  "reason": "example",
  "status": "PENDING",
  "updated": "2025-01-01T00:00:00Z"
}

Example

{
  "operation": {
    "amount": "123.45",
    "created": "2025-01-01T00:00:00Z",
    "externalOperationId": "example",
    "operationId": "123e4567-e89b-12d3-a456-426614174000",
    "operationType": "AUTHORIZE",
    "orderId": "example",
    "params": {},
    "pointsAmount": "123.45",
    "reason": "example",
    "status": "PENDING",
    "updated": "2025-01-01T00:00:00Z"
  }
}

Была ли статья полезна?

/v1/orders/{order_id}/rollback

Overview