Cancel a transaction
post
https://<your_gateway_host>
/api/payment/void
Void

Example Request

1
{
2
"id": "f40c7e45-931b-4899-bb45-f38bf6b228cd",
3
"data": {
4
"voidReason": "POST_AUTH_USER_DECLINE"
5
}
6
}
Copied!

Request Field Definition Table

Field ID
Description
transactionAmount
Format: Numeric|Max Length=12|Allowed characters: 0-12 .(dot) Note: If a decimal point is included, the amount reflects a dollar value. If a decimal point is not included, the amount reflects a cent value.
​
Description: The amount to be processed and includes the subtotal and any additional charges. If a request transaction amount includes a decimal point, the response will also include a decimal point. For void and return transactions, this is a conditional field. If this is not included in the request, then the full amount of the original transaction is voided.
For Debit Mastercard card a maximum of 7 digits are allowed in this field.
voidReason
Enumeration: Allowed Values: POST_AUTH_USER_DECLINE, DEVICE_TIMEOUT, DEVICE_UNAVAILABLE, PARTIAL_REVERSAL, TORN_TRANSACTION, POST_AUTH_CHIP_DECLINE
​
Description: Indicates the reason the transaction was voided
achCancelNote
Format: Alphanumeric and Special Character |Min Length=2 Max Length=60|Allowed characters: A-Z a-z 0-9 @ # % ( ) / . ' : $ , - _ [ ] { } *
​
Description: The reason for the ACH void transaction.
​
Webhook event: PAYMENT_VOIDED
Last modified 7mo ago