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

Successful order capture.

application/json

Schema

Schema

data object

orderNumber stringrequired

Unique code identifying the specific order.

operationType stringrequired

Possible values: [capture]

Operations type

Example (from schema)

{
  "data": {
    "orderNumber": "OREDER-324234",
    "operationType": "capture"
  }
}

400

Error

application/json

Schema

Schema

code stringrequired

Error code

title stringrequired

Detailed error description

detail string

Additional information about the error

Example (from schema)

{
  "code": "401",
  "title": "Input data validation error",
  "detail": "Parameter AAAA is required"
}

Loading...