POST /capture

Capture an order ---- [auth scope: api-user]

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderReferencestringRequired

The order reference to capture

Example: ORDER12345

Body

captureReferencestringRequired

A unique reference identifier for this capture request. This must be unique per merchant and transaction.

Example: 12345679280

descriptionstringOptional

An optional description or note for this capture. This can be used to record the reason for capture, shipping details, or other relevant information.

Example: manual capture

amountnumberRequired

The amount to capture from the authorized order. Must be a non-negative number with up to 2 decimal places. For full capture, this should equal the order amount plus surcharge. For partial capture (if the APM supports them), this can be any amount up to the remaining authorized amount. The sum of all captures (including this one) cannot exceed the total order amount plus surcharge.

Example: 1

Responses

200Success

application/json

captureReferencestringRequired

captureReference

Example: 632

captureIdstringRequired

captureId

Example: 632

capturedAmountnumberRequired

Amount to capture

Example: 100

400Error

application/json

401Error

application/json

404Error

application/json

post/orders/{orderReference}/capture

POST /orders/{orderReference}/capture HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "captureReference": "12345679280",
  "description": "manual capture",
  "amount": 1,
  "shippingInfo": {
    "shippingCompany": "FedEx",
    "shippingMethod": "Standard Delivery",
    "trackingNumber": "1234567890"
  }
}

{
  "captureReference": 632,
  "captureId": 632,
  "capturedAmount": 100
}

Sample Request/Response

Request

{
    "captureReference": "LatEHAuPtpN2HSrTMK-1",
    "description": "Please capture this order",
    "amount": 100
}

Response

{
    "captureReference": "LatEHAuPtpN2HSrTMK-1",
    "capturedAmount": 100,
    "captureId": "LatEHAuPtpN2HSrTMK-1"
}