Skip to main content
A void cancels a pre-authorization and releases the hold on the customer’s funds. Use this endpoint when you need to cancel a reservation before calling capture.
You can only void a pre-authorization. To reverse a completed sale or capture, use the refund endpoint instead.
Safe retries for this POST endpoint use the Idempotency-Key header. Reuse the same key only when retrying the exact same request body. See Idempotency.

Path parameters

terminal_friendly_id
string
required
Your terminal identifier. Exactly 6 characters.

Request body

transaction_reference_id
string
required
The transaction_id of the pre-authorization to void. Exactly 8 characters.
order_reference_id
string
required
The order_id associated with the pre-authorization. Exactly 8 characters.

Response

transaction_id
string
required
SmartRetry’s unique identifier for this void transaction. Exactly 8 characters.
order_id
string
required
The order identifier, matching the order_id from the original pre-authorization.
accepted
boolean
required
true if the void was accepted for processing. Poll the status endpoint using the returned transaction_id to confirm the void outcome.