v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

payments

Cancel a Payment

Cancel a payment.

post/payments/payment/{id}/cancel

Path parameters

idstring required

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Idempotency-Keystring

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Response

Successfully cancelled

idstring

The unique identifier of the payment.

cancelledboolean

Whether the payment was successfully cancelled.

reasonstring

The outcome of the cancellation request. Either 'Payment cancelled successfully' or 'Payment not cancellable'.

paymentPaymentsPaymentIdCancelPostResponsesContentApplicationJsonSchemaPayment

The full payment object reflecting its state after the cancellation attempt.