Cancel outbound payment

Cancels a payment that has not yet been sent for processing. A payment going through our checks, or already sent to the payment processor or bank, cannot be cancelled and returns 422; a payment that is already cancelled returns 409. An approved INR payment cannot be cancelled through the API and returns 422; contact IFX operations. The payment must be visible to the caller's auth group (a member's, or a member's sub-account's, payment); anything else returns 404. reason is required and must be one of: incorrect_amount, incorrect_payee, payment_not_required.

Path Params
string
required

The unique identifier of the payment to cancel

Body Params
string
enum
required
length ≥ 1

The cancellation reason: incorrect_amount, incorrect_payee, payment_not_required

Allowed:
Headers
string
required

Fresh RFC 9449 proof JWT (ES256) signed with the client's DPoP key, binding this request's method and URL to the access token; generate a new proof per request

Responses
204

Payment cancelled

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/problem+json