Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.smartretry.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.
curl --request POST \
  --url https://api.smartretry.com/v1/payments/void/ABC123 \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: void-20260331-001' \
  --data '{
    "transaction_reference_id": "TX8A3F2C",
    "order_reference_id": "OR7B9E1D"
  }'

{
  "transaction_id": "TX5F1K2L",
  "order_id": "OR7B9E1D",
  "accepted": true
}

​
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.