POST /capture

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

post
Authorizations
Path parameters
orderReferencestringRequired

The order reference to capture

Example: ORDER12345
Body
captureReferencestringRequired

The order capture reference.

descriptionstringOptional

The Description of the capture.

amountnumberRequired

The captured amount for the items shipped

shippingInfoall ofOptional

The order shipping information

Responses
200Success
application/json
post
POST /orders/{orderReference}/capture HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "captureReference": "text",
  "description": "text",
  "amount": 1,
  "shippingInfo": {
    "shippingCompany": "text",
    "shippingMethod": "text",
    "trackingNumber": "text"
  }
}
{
  "captureReference": 632,
  "captureId": 632,
  "capturedAmount": 100
}

Sample Request/Response

{
    "captureReference": "LatEHAuPtpN2HSrTMK-1",
    "description": "Please capture this order",
    "amount": 100
}
{
    "captureReference": "LatEHAuPtpN2HSrTMK-1",
    "capturedAmount": 100,
    "captureId": "LatEHAuPtpN2HSrTMK-1"
}
PreviousPOST /voidNextPOST /orders/{reference}/refunds

Last updated