/v1/orders/{order_id}/capture

Request to debit funds for the order.

Debiting of locked funds. Available only for payments in 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 that case, you need to pass the final cart of the provided products and services. The final cart is created from the current cart by excluding some items that were refunded.

Request

POST

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

Production

POST

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

Sandbox

Path parameters

Name

Description

order_id

Type: string

Order ID on the merchant's side that was passed in response to /order/create.

Max length: 2048

Example: ``

Body

application/json

{
  "cart": {
    "cartId": "example",
    "coupons": [
      {
        "description": "example",
        "status": "VALID",
        "value": "example"
      }
    ],
    "discounts": [
      {
        "amount": "123.45",
        "description": "example",
        "discountId": "example"
      }
    ],
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "measurements": null,
        "productId": "example",
        "quantity": null,
        "receipt": null,
        "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",
      "label": "example"
    }
  },
  "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": "example", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "123.45", "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "productId": "example", "quantity": { "available": "123.45", "count": "123.45", "label": "example" }, "receipt": { "agent": {}, "excise": "123.45", "markQuantity": {}, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": {}, "tax": 1, "title": "example" }, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": { "amount": "123.45", "label": "example" } } Final cart Example { "cartId": "example", "coupons": [ { "description": "example", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "123.45", "measurements": null, "productId": "example", "quantity": null, "receipt": null, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": { "amount": "123.45", "label": "example" } }
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: ShippingPrice Example `{ "amount": "123.45", "methodType": "DIRECT" }` Final delivery method. Example `{ "amount": "123.45", "methodType": "DIRECT" }`

Coupon

Name	Description
value	Type: string Coupon code Max length: `2048` Example: `example`
description	Type: string Description For example, "3% discount" Max length: `2048` Example: `example`
status	Type: string Enum: `VALID`, `INVALID`, `EXPIRED`, `null` Example: `VALID`

Example

{
  "description": "example",
  "status": "VALID",
  "value": "example"
}

Discount

Name	Description
amount	Type: string<double> Discount amount Example: `123.45`
description	Type: string Text description Max length: `2048` Example: `example`
discountId	Type: string Discount ID in the merchant system Max length: `2048` Example: `example`

Example

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

Measurements

Name	Description
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
}

ItemQuantity

Name	Description
count	Type: string<double> Product quantity in the order Example: `123.45`
available	Type: string<double> Maximum available product quantity Example: `123.45`
label	Type: string Name of measurement units, for example, "kg" or "pcs" Max length: `2048` Example: `example`

Example

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

PaymentsOperator

Name	Description
phones	Type: string[] Example `[ "example" ]`

Example

{
  "phones": [
    "example"
  ]
}

TransferOperator

Name	Description
address	Type: string Max length: `2048` Example: `example`
inn	Type: string Max length: `2048` Example: `example`
name	Type: string Max length: `2048` Example: `example`
phones	Type: string[] Example `[ "example" ]`

Example

{
  "address": "example",
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

Agent

Name	Description
agentType	Type: integer Agent type by taxable object. See values Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	Type: string Max length: `2048` Example: `example`
paymentsOperator	Type: PaymentsOperator Example `{ "phones": [ "example" ] }`
phones	Type: string[] Example `[ "example" ]`
transferOperator	Type: TransferOperator Example `{ "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] }`

Example

{
  "agentType": 1,
  "operation": "example",
  "paymentsOperator": {
    "phones": [
      "example"
    ]
  },
  "phones": [
    "example"
  ],
  "transferOperator": {
    "address": "example",
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  }
}

MarkQuantity

Name	Description
denominator	Type: integer
numerator	Type: integer

Example

{
  "denominator": 0,
  "numerator": 0
}

Supplier

Name	Description
inn	Type: string Max length: `2048` Example: `example`
name	Type: string Max length: `2048` Example: `example`
phones	Type: string[] Example `[ "example" ]`

Example

{
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

ItemReceipt

Name	Description
tax	Type: integer Value description: Link Enum: `1`, `2`, `3`, `4`, `5`, `6`
agent	Type: Agent Example `{ "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }`
excise	Type: string<double> It shouldn't include more than two decimal digits. For example: 1.12, 5.1, 10, 11.00 . Example: `123.45`
markQuantity	Type: MarkQuantity Example `{ "denominator": 0, "numerator": 0 }`
measure	Type: integer Value description: Link 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`
paymentMethodType	Type: integer Value description: Link Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `null`
paymentSubjectType	Type: integer Value description: Link 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`
productCode	Type: string<base64> Product code (a base64-encoded array of 1 to 32 bytes) Example: `example`
supplier	Type: Supplier Example `{ "inn": "example", "name": "example", "phones": [ "example" ] }`
title	Type: string Max length: `2048` Example: `example`

Example

{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

CartItemWithoutFinalPriceCamelCase

Name	Description
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: ItemQuantity Example `{ "available": "123.45", "count": "123.45", "label": "example" }` Product quantity in the order Example `{ "available": "123.45", "count": "123.45", "label": "example" }`
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`
measurements	All of 1 type Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }` Product dimensions and weight. Required for the `PHYSICAL` product Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
receipt	All of 1 type Type: ItemReceipt Example { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" } Data for receipt generation Example { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "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 price per item with item discount Example: `123.45`
type	Type: string Product type. Important for integrating with delivery services Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Total price per product unit without discount Example: `123.45`

Example

{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "measurements": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45",
    "label": "example"
  },
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

Cart cost with all discounts

Example: 123.45

label

Type: string

Name of measurement units, for example, "kg" or "pcs"

Max length: 2048

Example: example

Example

{
  "amount": "123.45",
  "label": "example"
}

CartWithRequiredTotalWithoutFinalPrice

Name	Description
items	Type: CartItemWithoutFinalPriceCamelCase[] Example [ { "description": "example", "discountedUnitPrice": "123.45", "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "productId": "example", "quantity": { "available": "123.45", "count": "123.45", "label": "example" }, "receipt": { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": {}, "phones": [ null ], "transferOperator": {} }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ null ] }, "tax": 1, "title": "example" }, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ]
total	Type: CartTotal Example `{ "amount": "123.45", "label": "example" }`
cartId	Type: string The internal ID of the Yandex Pay cart. The store's backend must use this parameter as the ID of the customer cart and the idempotency key for the `/order/create` request. If the store's backend receives a repeat `/order/create` request, return the existing order ID. The store's backend can create no more than one order (`orderId`) per cart (`cartId`). Max length: `2048` Example: `example`
coupons	Type: Coupon[] Coupons applied to the cart Example `[ { "description": "example", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Discounts applied to the cart Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Cart ID passed by the merchant 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": "example",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45",
        "label": "example"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": {
    "amount": "123.45",
    "label": "example"
  }
}

ShippingPrice

Name

Description

amount

Type: string<double>

It shouldn't include more than two decimal digits. For example: 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 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: ItemQuantity Example `{ "available": "123.45", "count": "123.45", "label": "example" }` Product quantity in the order Example `{ "available": "123.45", "count": "123.45", "label": "example" }`
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`
measurements	All of 1 type Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }` Product dimensions and weight. Required for the `PHYSICAL` product Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
pointsAmount	Type: string<double> Number of Plus points Read-only field. Input values will be ignored. Example: `123.45`
receipt	All of 1 type Type: ItemReceipt Example { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" } Data for receipt generation Example { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "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 price per item with item discount Example: `123.45`
type	Type: string Product type. Important for integrating with delivery services Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Total price per product unit without discount Example: `123.45`

Example

{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "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",
    "label": "example"
  },
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name	Description
amount	Type: string<double> Cart cost with all discounts Example: `123.45`
label	Type: string Name of measurement units, for example, "kg" or "pcs" Max length: `2048` Example: `example`
pointsAmount	Type: string<double> Number of Plus points Read-only field. Input values will be ignored. Example: `123.45`

Example

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

CartWithRequiredTotalWithoutFinalPrice

Name	Description
items	Type: CartItemWithoutFinalPriceCamelCase[] Example [ { "description": "example", "discountedUnitPrice": "123.45", "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", "label": "example" }, "receipt": { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": {}, "phones": [ null ], "transferOperator": {} }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ null ] }, "tax": 1, "title": "example" }, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ]
total	Type: CartTotal Example `{ "amount": "123.45", "label": "example", "pointsAmount": "123.45" }`
cartId	Type: string The internal ID of the Yandex Pay cart. The store's backend must use this parameter as the ID of the customer cart and the idempotency key for the `/order/create` request. If the store's backend receives a repeat `/order/create` request, return the existing order ID. The store's backend can create no more than one order (`orderId`) per cart (`cartId`). Max length: `2048` Example: `example`
coupons	Type: Coupon[] Coupons applied to the cart Example `[ { "description": "example", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Discounts applied to the cart Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Cart ID passed by the merchant 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": "example",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "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",
        "label": "example"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": {
    "amount": "123.45",
    "label": "example",
    "pointsAmount": "123.45"
  }
}

Operation

Name	Description
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> Transaction amount in Plus points 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"
}

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

Was the article helpful?

/v2/orders/{order_id}/refund

/v1/orders/{order_id}/rollback