Void Transaction

curl --request POST \
  --url https://api.payaza.africa/live/card/auth_capture/void \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authorization_reference": "AUTH-ABCD1234EFGH5678IJKL",
  "void_reference": "VOID-001",
  "void_reason": "Customer cancellation"
}
'

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

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:

Partially captured authorizations cannot be voided: If any amount has been captured, void is not allowed. The response will indicate the remaining capturable amount..

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.

Authentication: Valid Authorization header required (same format as authorize endpoint).

Only fully authorized (uncaptured) transactions can be voided: Void is only allowed for authorizations that have never been captured.

POST

card

auth_capture

void

Void Transaction

curl --request POST \
  --url https://api.payaza.africa/live/card/auth_capture/void \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authorization_reference": "AUTH-ABCD1234EFGH5678IJKL",
  "void_reference": "VOID-001",
  "void_reason": "Customer cancellation"
}
'

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

Authorizations

Authorization

string

header

required

Payaza {{Public API Key in Base 64}}

Body

application/json

authorization_reference

string

required

The reference of the authorization to be voided.

Example:

"AUTH-ABCD1234EFGH5678IJKL"

void_reference

string

required

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

Example:

"VOID-001"

void_reason

string | null

Reason for voiding the transaction.

Example:

"Customer cancellation"

Response

Void Transaction

status

string

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

Example:

"VOIDED"

message

string

Descriptive message about the operation status.

Example:

"Void successful"

void_reference

string | null

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

Example:

"VOID-1705123456-WXYZ5678"

voided_amount

number | null

The amount successfully voided.

Example:

100

remaining_amount

number | null

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

Example:

0

Capture Transaction Get Single Authorization