/v1/orders/{order_id}/capture

Request to debit funds for the order.

Debiting of locked funds. Only available for payments in the AUTHORIZED status. If the request result is successful, the payment status changes to CAPTURED.

If the authorized amount is smaller than the original amount, the remaining part of the payment will be refunded. In this case, pass the final cart of products and services provided. The final cart must be based on the current cart, excluding refunded items.

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

The merchant-side order ID returned in response to /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",
  "shipping": {
    "amount": "123.45",
    "methodType": "DIRECT"
  }
}

Name

Description

cart
All of 1 type

  • Type: object

    items
    Type: object[]

    productId

    Type: string

    Product ID in the merchant system. Make sure that each productId in the request parameters is unique.

    Max length: 2048

    Example: example

    quantity
    All of 1 type

    • Type: object

      count

      Type: string<double>

      Product quantity in the order

      Example: 123.45

      available

      Type: string<double>

      Maximum available product quantity

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

    Product quantity in the order

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

    description

    Type: string

    Product description

    Max length: 2048

    Example: example

    discountedUnitPrice

    Type: string<double>

    Price per product unit with discount per item

    Example: 123.45

    features
    All of 1 type

    • Type: object

      pointsDisabled

      Type: boolean

      Unavailable in Uzbekistan.

      Default: false

      tariffModifier

      Type: string

      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

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

    Product promo parameters

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

    measurements
    All of 1 type

    • Type: object

      height

      Type: number

      Height, in meters

      length

      Type: number

      Length, in meters

      weight

      Type: number

      Weight, in kilograms

      width

      Type: number

      Width, in meters
      Example
      {
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

    Product dimensions and weight. Required for the PHYSICAL product type

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

    skuId

    Type: string

    Unique ID that describes a product range unit. Required when applying individual rates.

    Max length: 2048

    Example: example

    subtotal

    Type: string<double>

    Total price per item without discount

    Example: 123.45

    title

    Type: string

    Product name

    Max length: 2048

    Example: example

    total

    Type: string<double>

    Total item price including item-level discounts

    Example: 123.45

    type

    Type: string

    Product type. Important for integrating with delivery services

    Default: UNSPECIFIED

    Enum: PHYSICAL, DIGITAL, UNSPECIFIED

    unitPrice

    Type: string<double>

    Full unit price excluding discounts

    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"
  }
]

    total
    Type: object

    amount

    Type: string<double>

    Cart cost with all discounts

    Example: 123.45
    Example
    {
  "amount": "123.45"
}

    cartId

    Type: string

    Cart ID on the Yandex side

    Max length: 2048

    Example: example

    coupons
    Type: object[]

    value

    Type: string

    Coupon code

    Max length: 2048

    Example: example

    description

    Type: string

    Coupon description

    Max length: 2048

    Example: Скидка 3%

    status

    Type: string

    Enum: VALID, INVALID, EXPIRED, null

    Example: VALID

    Coupons applied to the cart

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

    discounts
    Type: object[]

    amount

    Type: string<double>

    Discount amount

    Example: 123.45

    description

    Type: string

    Text description

    Max length: 2048

    Example: example

    discountId

    Type: string

    Discount identifier in the merchant system

    Max length: 2048

    Example: example

    Discounts applied to the cart

    Example
    [
  {
    "amount": "123.45",
    "description": "example",
    "discountId": "example"
  }
]

    externalId

    Type: string

    Merchant-side cart identifier

    Max length: 2048

    Example: example

    measurements
    Type: object

    height

    Type: number

    Height, in meters

    length

    Type: number

    Length, in meters

    weight

    Type: number

    Weight, in kilograms

    width

    Type: number

    Width, in meters
    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": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "total": {
    "amount": "123.45"
  }
}

Final cart

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": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "total": {
    "amount": "123.45"
  }
}

externalOperationId

Type: string

Operation ID

Max length: 2048

Example: example

orderAmount

Type: string<double>

Amount to be debited. If not specified, the total amount of the passed cart items will be debited

Example: 123.45

shipping
All of 1 type

  • Type: object

    amount

    Type: string<double>

    It shouldn't include more than two decimal digits. For example: 1.12, 5.1, 10, or 11.00.

    Example: 123.45

    methodType

    Type: string

    Enum: DIRECT, PICKUP, COURIER, YANDEX_DELIVERY
    Example
    {
  "amount": "123.45",
  "methodType": "DIRECT"
}

Final delivery method.

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: object

operation
Type: object

amount

Type: string<double>

Transaction amount in a fiat currency

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>

Date and time when the operation was created (ISO 8601)

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

externalOperationId

Type: string

Operation ID on the merchant side

Max length: 2048

Example: example

params

Type: object

Example
{}

pointsAmount

Type: string<double>

Unavailable in Uzbekistan.

Example: 123.45

reason

Type: string

Error cause

Max length: 2048

Example: example

status

Type: string

Default: PENDING

Enum: PENDING, SUCCESS, FAIL

updated

Type: string<date-time>

Date and time when the operation was updated (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"
}
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
Previous
/v2/orders/{order_id}/refund
Next
/v1/orders/{order_id}/rollback