For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

In-Store - Cancel transaction

Using the POS, cancel a transaction.

Important: For authentication, you must include the required HTTPS headers in each request. For more information about the authentication HTTPS headers, see Authenticating Your Requests.

Important

The PUT request doesn’t contain a message body. Include your reference_id in the URL. If a cancel request is successful, the gateway returns two responses:

A response for the cancel request.
A response for the transaction that the POS canceled.

Don’t program the POS to receive these responses in any particular order, because the gateway may send one response before the other.

Endpoints

Environment	HTTP Method	URL
Partner Integration Test	PUT	https://api.pit.paygateway.com/terminal/request/reference_id/{reference_id}/cancel
Production	PUT	https://api.paygateway.com/terminal/request/reference_id/{reference_id}/cancel

Response fields

The response to a cancel request doesn’t contain a message body. The HTTP status code indicates if the request was successful.

If the POS receives an HTTP status code of 403, the POS can’t cancel the transaction due to one of the following reasons:

The transaction doesn’t exist.
The terminal sent the transaction to us for processing. The merchant needs to void the transaction.

Field	Type	Description
amount	String	Total dollar amount of the transaction. If the cancel request was successful, we return a value of 0.00.
status	String	Indicates the status of the transaction. If the cancel request was successful, we return a value of `pos_cancelled`.
currency_code	String	ISO currency code for the transaction.