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.

POST /v1/payments/recurring/future-transactions/cancel/{terminal_friendly_id} Cancels a single upcoming payment within a recurring series. The rest of the billing schedule continues as normal - only the targeted occurrence is skipped. Use this when you need to waive a specific payment, for example to honor a promotional credit or account adjustment.
This cancels only the specified future transaction. To stop all future payments and end the entire series, use the recurring cancel 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/recurring/future-transactions/cancel/ABC123 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Idempotency-Key: future-cancel-20260401-001' \
  --data '{
    "future_transaction_id": "FT3D8E1C",
    "recurring_id": "RC9F4A2B"
  }'

​
Path parameters

​
terminal_friendly_id
string
required
Your 6-character terminal identifier.

​
Request body

​
future_transaction_id
string
required
The 8-character identifier of the future transaction to cancel.
​
recurring_id
string
required
The 8-character identifier of the recurring series this future transaction belongs to.

​
Response

​
future_transaction_id
string
The identifier of the cancelled future transaction (8 characters).
​
accepted
boolean
true if the cancellation was accepted and the transaction has been marked as cancelled.
Example response
{
  "future_transaction_id": "FT3D8E1C",
  "accepted": true
}
After cancellation, the transaction status changes to cancelled. You can confirm this by calling the future transaction status endpoint.