Cancel a payment

Withdraws a payment you created, before it settles.

Required permission: reject:transfer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier for the payment.

Body Params
string

Why the payment is being cancelled. Shared with the counterparty.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

429

Too Many Requests: more than 6,000 calls in 300 seconds. Every endpoint refuses your calls for the next 10 seconds. Send the request again with a backoff, as Rate limiting explains.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json