Skip to main content
POST
Void a Transaction

Key Points

  • The Void Authorization API is crucial when a decision is made not to proceed with a transaction that has been authorised but not yet captured.
  • Once the authorization is voided, the funds that were held on the customer’s account are released, making them available to the customer again.
  • This API is typically used in scenarios where an order is cancelled before fulfilment or if there’s a change in transaction details requiring re-authorisation.

Flow diagram

Flow diagram image

Api Parameters

Authorizations

Authorization
string
header
required

API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'

x-api-key
string
header
required

API Key specific to x-api-key.

Body

application/json

The request payload to void a transaction.

transactionId
string
required

The original transaction ID of the authorized transaction.

Maximum string length: 36
Example:

"ab8444e7-fec0-40dd-994d-0ad813785f74"

merchant_id
string
required

The merchant ID (DASMID).

Maximum string length: 10
Example:

"< Merchant ID >"

Response

201 - application/json

Transaction voided successfully

success
boolean

True on successful transaction, false on failure.

Example:

true

status_code
integer

The status code of the transaction.

Example:

201

is_live
boolean

True if live transaction, false if test transaction.

Example:

false

transaction_type
string

The transaction type (e.g., VOID).

Example:

"VOID"

gateway_response
object

A JSON object containing the response from the gateway.

merchant_details
object

A JSON object containing the details of the merchant.

payment_details
object

A JSON object containing the payment details of the transaction.

transaction_details
object

A JSON object containing details of the transaction.