Skip to main content
POST
cURL
Cancel one future transaction using its future_transaction_id and recurring_id.
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.

Authorizations

x-api-key
string
header
required

Headers

idempotency-key
string

Optional idempotency key, scoped to terminal + matched route pattern. A replayed request returns the cached response with Idempotency-Replayed: true.

Maximum string length: 255
Pattern: ^[\w-]+$

Path Parameters

terminal_friendly_id
string
required

The unique identifier of the terminal.

Required string length: 6
Pattern: ^[\dA-Za-z]{6}$

Body

application/json
future_transaction_id
string
required

The future transaction identifier to cancel.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
recurring_id
string
required

The recurring subscription identifier this future transaction belongs to.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$

Response

Default Response

recurring_id
string
required
Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
future_transaction_id
string
required
Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
cancelled
boolean
required