Skip to main content
POST
Cancel checkout session
Cancels a pending checkout session — the hosted page then treats it as closed and no deposit will be accepted. No API key required (possession of the payment id is the gate for this public checkout flow).
  • Idempotent — cancelling an already-cancelled session returns 200 { "status": "cancelled" } again.
  • Any other non-pending state returns 409, e.g. Only pending payments can be cancelled (current status: completed).
Sessions that simply run out of time are marked expired automatically (see expires_at on the session) — you don’t need to cancel those. To expire one early yourself, cancel it while it’s still pending.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Cancelled (or already cancelled)