Void

VOID request

The VOID request is used to cancel the operation which was performed the same financial day.

The cancellation is possible for the SALE operation.

The VOID request is allowed for the payments in SETTLED status only.

This request is sent by POST in the background (e.g. through PHP CURL).

Request parameters

Parameter	Description	Limitations	Required
action	Action to perform	= VOID	+
client_key	Unique client key	CLIENT_KEY	+
trans_id	Transaction ID in the Payment Platform	String up to 255 characters	+
hash	Special signature to validate your request to Payment Platform	See Appendix A, Void signature.	+

Response parameters

You will get JSON encoded string with transaction result.

Successful void response

Parameter	Description
action	VOID
result	SUCCESS
status	VOID
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform

Unsuccessful void response

Parameter	Description
action	VOID
result	DECLINED
status	SETTLED
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform
decline_reason	The reason why the transaction was declined

Undefined void response

Parameter	Description
action	VOID
result	UNDEFINED
status	SETTLED
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform

Callback parameters

Successful void response

Parameter	Description
action	VOID
result	SUCCESS
status	VOID
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform
connector_name *	Connector's name (Payment Gateway)
rrn *	Retrieval Reference Number value from the acquirer system
approval_code *	Approval code value from the acquirer system
gateway_id *	Gateway ID – transaction identifier provided by payment gateway
extra_gateway_id *	Extra Gateway ID – additional transaction identifier provided by payment gateway.
merchant_name *	Merchant Name
mid_name *	MID Name
issuer_country *	Issuer Country
issuer_bank *	Issuer Bank
hash	Special signature, used to validate callback, see Appendix A, Formula 2

* The parameters are included if the appropriate setup is configured in the admin panel (see “Add Extended Data to Callback” block in the Configurations -> Protocol Mappings section).

Unsuccessful void response

Parameter	Description
action	VOID
result	DECLINED
status	SETTLED
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform
decline_reason	The reason why the transaction was declined
hash	Special signature, used to validate callback, see Appendix A, Formula 2

Undefined void response

Parameter	Description
action	VOID
result	UNDEFINED
status	SETTLED
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform
hash	Special signature, used to validate callback, see Appendix A, Formula 2