Skip to main content
POST
Cancel an authorized payment

Authorizations

Authorization
string
header
required

Secret key, kc_sk_test_... or kc_sk_live_.... Server-side only.

Headers

Idempotency-Key
string
required

Unique key per logical request, reused on retries. 1 to 255 characters.

Required string length: 1 - 255

Path Parameters

id
string
required

Response

Cancellation requested.

id
string
required
Example:

"cnl_01JABCDEF"

object
string
required
Allowed value: "cancellation"
payment
string
required
status
enum<string>
required
Available options:
pending,
succeeded,
failed
created_at
string<date-time>
required
failure_reason
string | null