Capture Order (🚧 in development)
POST/order/capture
This endpoint allows you to confirm an order in case of two-step payment. To utilize this endpoint, the autocapture
parameter should be set to false
. This action is only available for orders with the status 'in_progress' and the payments
array within the response from the Retrieve Order Details endpoint must include at least one payment item. Refer to the Order Actions and Conditions.
Request​
- application/json
Body
Order parameters
shopId integerrequired
ID of the shop where the order is placed. How to get your shopId
orderNumber stringrequired
Unique code identifying the specific order.
Responses​
- 200
- 400
Successful order capture.
- application/json
- Schema
- Example (from schema)
Schema
data object
orderNumber stringrequired
Unique code identifying the specific order.
operationType stringrequired
Possible values: [capture
]
Operations type
{
"data": {
"orderNumber": "OREDER-324234",
"operationType": "capture"
}
}
Error
- application/json
- Schema
- Example (from schema)
Schema
code stringrequired
Error code
title stringrequired
Detailed error description
detail string
Additional information about the error
{
"code": "401",
"title": "Input data validation error",
"detail": "Parameter AAAA is required"
}
Loading...