/v1/orders/{order_id}/capture

Buyurtma bo‘yicha mablag‘ni yechish so‘rovi.

Bloklangan mablag‘larni yechish. Faqat AUTHORIZED holatidagi to‘lovlar uchun mavjud. So‘rov muvaffaqiyatli bajarilganda to‘lov statusi CAPTUREDga o‘zgaradi.

Agar tasdiqlash summasi asl summadan kamroq yuborilsa, qolgan qismi avtomatik ravishda qaytariladi. Bunday holatda taqdim etilayotgan mahsulot va xizmatlarning yakuniy savatini yuborish kerak. Yakuniy savat joriy savat asosida shakllantiriladi, bunda qaytarilgan ayrim pozitsiyalar chiqarib tashlanadi.

Request

POST

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

Production

POST

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

Sandbox

Path parameters

Name

Description

order_id

Type: string

Sotuvchi tomonidagi buyurtma identifikatori, u /orders so‘roviga javobda yuborilgan.

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",
  "shipping": {
    "amount": "123.45",
    "methodType": "DIRECT"
  }
}

Name	Description
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" } } Yakuniy savat 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" } }
externalOperationId	Type: string Operatsiya identifikatori Max length: `2048` Example: `example`
orderAmount	Type: string<double> Yechib olinadigan summa. Agar ko‘rsatilmagan bo‘lsa, kiritilgan savatning yakuniy qiymati yechib olinadi. Example: `123.45`
shipping	All of 1 type Type: ShippingPrice Example `{ "amount": "123.45", "methodType": "DIRECT" }` Yakuniy yetkazish usuli Example `{ "amount": "123.45", "methodType": "DIRECT" }`

Coupon

Name	Description
value	Type: string Kupon kodi Max length: `2048` Example: `example`
description	Type: string Kupon tavsifi 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> Chegirma summasi Example: `123.45`
description	Type: string Matnli tavsif Max length: `2048` Example: `example`
discountId	Type: string Sotuvchi tizimidagi chegirma identifikatori Max length: `2048` Example: `example`

Example

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

CartItemFeatures

Name

Description

pointsDisabled

Type: boolean

O‘zbekistonda mavjud emas.

Default: false

tariffModifier

Type: string

Komissiyani hisoblash uchun tarif modifikatori. Savatdagi pozitsiyani qayta ishlash uchun komissiya hisoblanayotganda qaysi tarif qo‘llanishini belgilaydi.

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

Example: VERY_LOW

Example

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

Measurements

Name	Description
height	Type: number Balandligi, metrda
length	Type: number Uzunligi, metrda
weight	Type: number Og‘irligi, kilogrammda
width	Type: number Kengligi, metrda

Example

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

ItemQuantity

Name

Description

count

Type: string<double>

Buyurtmadagi mahsulot miqdori

Example: 123.45

available

Type: string<double>

Mahsulot uchun maksimal mavjud miqdor

Example: 123.45

Example

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

CartItemWithoutFinalPriceCamelCase

Name	Description
productId	Type: string Sotuvchi tizimidagi mahsulot ID raqami. So‘rov parametrlarida har bir mahsulot identifikatori `productId` unikal bo‘lishi kerak. Max length: `2048` Example: `example`
quantity	All of 1 type Type: ItemQuantity Example `{ "available": "123.45", "count": "123.45" }` Buyurtmadagi mahsulot miqdori Example `{ "available": "123.45", "count": "123.45" }`
description	Type: string Mahsulot tavsifi Max length: `2048` Example: `example`
discountedUnitPrice	Type: string<double> Bir pozitsiya uchun chegirmalarni hisobga olgan holda mahsulot birligining narxi Example: `123.45`
features	All of 1 type Type: CartItemFeatures Example `{ "pointsDisabled": false, "tariffModifier": "VERY_LOW" }` Mahsulot promo parametrlari 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 }` Mahsulotning o‘lchamlari va og‘irligi. `PHYSICAL` turidagi mahsulotlar uchun majburiy Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
skuId	Type: string Assortiment birligini tavsiflovchi noyob ID raqam. Individual tarifni qo‘llash uchun zarur. Max length: `2048` Example: `example`
subtotal	Type: string<double> Chegirmalarsiz pozitsiya bo‘yicha umumiy narx Example: `123.45`
title	Type: string Mahsulot nomi Max length: `2048` Example: `example`
total	Type: string<double> Pozitsiya bo‘yicha chegirmalar hisobga olingan umumiy narx Example: `123.45`
type	Type: string Mahsulot turi. Yetkazish xizmatlari bilan integratsiya uchun muhim Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Chegirmasiz bir dona mahsulotning to‘liq narxi 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>

Barcha chegirmalar hisobga olingan savat qiymati.

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 Yandex tomonidagi savat identifikatori Max length: `2048` Example: `example`
coupons	Type: Coupon[] Savatga qo‘llangan kuponlar Example `[ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Savatga qo‘llangan chegirmalar Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Sotuvchi tomonidagi savat identifikatori 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"
  }
}

ShippingPrice

Name

Description

amount

Type: string<double>

Verguldan keyin ikki xonadan ortiq belgi bo‘lmasligi kerak. Masalan: 1,12, 5,1, 10, 11,00

Example: 123.45

methodType

Type: string

Enum: DIRECT, PICKUP, COURIER, YANDEX_DELIVERY

Example

{
  "amount": "123.45",
  "methodType": "DIRECT"
}

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 Sotuvchi tizimidagi mahsulot ID raqami. So‘rov parametrlarida har bir mahsulot identifikatori `productId` unikal bo‘lishi kerak. Max length: `2048` Example: `example`
quantity	All of 1 type Type: ItemQuantity Example `{ "available": "123.45", "count": "123.45" }` Buyurtmadagi mahsulot miqdori Example `{ "available": "123.45", "count": "123.45" }`
description	Type: string Mahsulot tavsifi Max length: `2048` Example: `example`
discountedUnitPrice	Type: string<double> Bir pozitsiya uchun chegirmalarni hisobga olgan holda mahsulot birligining narxi Example: `123.45`
features	All of 1 type Type: CartItemFeatures Example `{ "pointsDisabled": false, "tariffModifier": "VERY_LOW" }` Mahsulot promo parametrlari 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 }` Mahsulotning o‘lchamlari va og‘irligi. `PHYSICAL` turidagi mahsulotlar uchun majburiy Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
pointsAmount	Type: string<double> O‘zbekistonda mavjud emas. Example: `123.45`
skuId	Type: string Assortiment birligini tavsiflovchi noyob ID raqam. Individual tarifni qo‘llash uchun zarur. Max length: `2048` Example: `example`
subtotal	Type: string<double> Chegirmalarsiz pozitsiya bo‘yicha umumiy narx Example: `123.45`
title	Type: string Mahsulot nomi Max length: `2048` Example: `example`
total	Type: string<double> Pozitsiya bo‘yicha chegirmalar hisobga olingan umumiy narx Example: `123.45`
type	Type: string Mahsulot turi. Yetkazish xizmatlari bilan integratsiya uchun muhim Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Chegirmasiz bir dona mahsulotning to‘liq narxi 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>

Barcha chegirmalar hisobga olingan savat qiymati.

Example: 123.45

pointsAmount

Type: string<double>

O‘zbekistonda mavjud emas.

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 Yandex tomonidagi savat identifikatori Max length: `2048` Example: `example`
coupons	Type: Coupon[] Savatga qo‘llangan kuponlar Example `[ { "description": "Скидка 3%", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Savatga qo‘llangan chegirmalar Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Sotuvchi tomonidagi savat identifikatori 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> Operatsiya summasi fiat valyutada 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> Operatsiya yaratilgan sana va vaqt (ISO 8601) Example: `2025-01-01T00:00:00Z`
externalOperationId	Type: string Sotuvchi tomonidagi tranzaksiya identifikatori Max length: `2048` Example: `example`
params	Type: object Example `{}`
pointsAmount	Type: string<double> O‘zbekistonda mavjud emas. Example: `123.45`
reason	Type: string Xatolik sababi Max length: `2048` Example: `example`
status	Type: string Default: `PENDING` Enum: `PENDING`, `SUCCESS`, `FAIL`
updated	Type: string<date-time> Operatsiya yangilangan sana va vaqt (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"
  }
}

Maqola foyda berdimi?

Avvalgisi

/v2/orders/{order_id}/refund

Keyingisi

/v1/orders/{order_id}/rollback