POST /void

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

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderReferencestringRequired

The unique order reference that was provided when creating the order. This is your merchant-specific identifier for the order. Use this reference to identify which order to perform operations on (e.g., capture, void, refund, get status).

Example: ORD-2024-001234

Body

application/json

voidReferencestringRequired

A unique reference identifier for this void request. This must be unique per merchant.

Example: 12345679281

descriptionstringOptional

An optional description or note for this void. This can be used to record the reason for voiding the order (e.g., "order cancelled", "customer requested cancellation"). This description is stored with the void record for reference.

Example: voided order due to cancellation by customer

amountnumberRequired

The amount to void from the authorized order. Must be a positive number with up to 2 decimal places. For full void, this should equal the remaining uncaptured authorized amount (order amount plus surcharge minus any previously captured amounts). For partial void (if the APM supports it), this can be any amount up to the remaining uncaptured authorized amount. The sum of all captures and voids cannot exceed the total order amount plus surcharge. If the APM does not support partial voids it must be equal to the full authorized amount.

Example: 2

Responses

200Success

application/json

400Error

application/json

401Error

application/json

404Error

application/json

post

/orders/{orderReference}/void

HTTPcURLJavaScriptPython

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

{
  "voidReference": "12345679281",
  "description": "voided order due to cancellation by customer",
  "amount": 2
}

{
  "voidReference": "12345679281",
  "voidedId": "26062711",
  "amount": 2
}

Sample Request/Response

Request

{
    "voidReference": "LatEHAuPtpN2HSrTMK-1",
    "description": "Please void this order",
    "amount": 100
}

Response

{
    "voidReference": "LatEHAuPtpN2HSrTMK-1",
    "amount": 100,
    "voidedId": "LatEHAuPtpN2HSrTMK-1"
}