Void

Voiding cancels an authorized payment before capture. The reserved funds are released back to the cardholder's account.

Key Rules

Only possible if the payment has not yet been captured
Voids are irreversible — the payment cannot be re-captured after voiding
If the payment was already captured, use Refund instead
The externalPaymentId identifies the payment to void

Endpoint

POST https://{FQDN}/payments/{externalPaymentId}/void

Headers:

Header	Value
`Authorization`	`Bearer {accessToken}`
`Content-Type`	`application/json`

Request Body

None required.

Example

curl -X POST https://{FQDN}/payments/order-12345/void \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...' \
  -H 'Content-Type: application/json'

Response (200)

{
  "paymentId": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "parentPaymentId": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "externalPaymentId": "order-12345",
  "amount": 100.10,
  "created": "2024-04-22 16:22:06",
  "approved": true,
  "message": "Payment Approved",
  "automaticReversed": false,
  "status": "VOIDED",
  "captured": false,
  "voided": true,
  "authCode": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "issuerName": "BANK OF AMERICA",
  "issuerCountry": "US",
  "cvcResult": "APPROVED",
  "avsResult": "NOT_SENT"
}

Note: The original void doc showed "status": "CAPTURED" in the response — this was incorrect. A voided payment has "status": "VOIDED".