Voiding a transaction is a cancellation request. A void can be performed on auth, postauth, or return transactions. A void is applied to the most recent previous transaction of one of these types. A void against an auth will prevent the auth from being marked for settlement. An auth can be voided anytime prior to it being postauthed. A void against a return or postauth will prevent the transaction from being swept to the bank. A return or postauth can be voided only prior to the transaction being swept to the bank which is once a day. The time of day a transactions is swept varies per processor.

Transaction Administration - Void

Overview

The Void operation cancels an authorization associated with a given orderID. The Remote API requires txn-type set to auth.

Request Parameters

Variable	Requirement	Type	Max Size	Possible Values / Example	Description	Notes
`publisher-name`	Mandatory	string	N/A	Example: `gatewayuser`	Gateway account username issued to you.
`publisher-password`	Mandatory	string	N/A	Example: `securepassword`	Remote Client Password used for API authentication.	This differs from the administrative login password.
`mode`	Mandatory	string	N/A	`void`	Specifies void operation.	Must be set to `void`.
`orderID`	Mandatory	string	20	Example: `1234567890`	Original transaction identifier to be voided.	Required for locating the transaction record.
`card-amount`	Mandatory	decimal	10	`1234.56`	Amount associated with the transaction being voided. ¹	Must match the transaction amount.
`txn-type`	Mandatory	string	N/A	`auth`	Specifies the type of transaction being voided.	Must be set to `auth`.
`notify-email`	Optional	string	39	`user@example.com`	Email address for void-related alerts.	Used for error notifications.

Response Parameters

Variable	Value	Description	Notes
`FinalStatus`	`success`, `problem`	Indicates overall result of the void request.
`success`	`yes`, `no`	Indicates whether the void succeeded.
`Mstatus`	`success`, `problem`, `pending`	Legacy status field.	Deprecated in favor of `FinalStatus`.
`aux-msg`	string	Informational success message.	Example: order successfully voided.
`MErrMsg`	string	Error message returned on failure.	Indicates why the void could not be processed.
`Duplicate`	`yes`, blank	Indicates duplicate submission of `orderID`.	If `yes`, original transaction data is returned unchanged.

⚠️ Formatting Rule (Applies to All Amount Fields)

All monetary values must be numeric only in the format 1234.56. Do not include currency symbols, commas, or formatting. Exactly two decimal places are required. ↩︎