Skip to main content
POST
payments.payment.cancel-by-key

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
originalIdempotencyKey
string
required

The exact creation key originally sent to your payment account when the payment was created. This is separate from this call's Idempotency-Key.

Required string length: 1 - 45
Pattern: ^[^\p{Cc}]+$

Response

The result

canceled
boolean
required

Cancellation request acknowledged by the payment account.