Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Auth-Capture-Void

Void Transaction

This endpoint voids a previously authorized transaction. This request can only be done on transactions that are fully authorized and have not been captured

Notes:

  1. Partially captured authorizations cannot be voided: If any amount has been captured, void is not allowed. The response will indicate the remaining capturable amount..
  2. Fully captured authorizations cannot be voided:: Once a transaction is fully captured (status becomes CAPTURED), it cannot be voided. You must use the refund API instead.
  3. Authentication: Valid Authorization header required (same format as authorize endpoint).
  4. Only fully authorized (uncaptured) transactions can be voided: Void is only allowed for authorizations that have never been captured.
post/card/auth_capture/void

Request body

authorization_referencestring required

The reference of the authorization to be voided.

void_referencestring required

A unique reference for this void transaction generated by the merchant.

void_reasonstring nullable

Reason for voiding the transaction.

Example request

{
  "authorization_reference": "AUTH-ABCD1234EFGH5678IJKL",
  "void_reference": "VOID-001",
  "void_reason": "Customer cancellation"
}

Response

Void Transaction

statusstring

Status of the void operation (e.g., VOIDED, ERROR).

messagestring

Descriptive message about the operation status.

void_referencestring nullable

Unique reference for the void transaction (present on success).

voided_amountnumber nullable

The amount successfully voided.

remaining_amountnumber nullable

Any remaining amount on the authorization (usually 0 after a full void).

Example response

{
  "status": "VOIDED",
  "message": "Void successful",
  "void_reference": "VOID-1705123456-WXYZ5678",
  "voided_amount": 100
}