Skip to main content
POST
Cancel Payout

Authorizations

Authorization
string
header
required

Secret API key from Settings → Developers → API keys. Example: Authorization: Bearer sk_test_…

Path Parameters

id
string<uuid>
required

Response

Cancelled payout

object
enum<string>
required

Object type discriminator.

Available options:
payout
id
string<uuid>
required

Payout id.

status
enum<string>
required

Lifecycle status. pending_approval means maker-checker is waiting on a second admin in the dashboard. queued/sending are in flight.

Available options:
awaiting_auth,
pending_approval,
queued,
sending,
completed,
failed,
cancelled,
rejected,
expired
currency
string
required

Source book currency that was (or will be) debited.

amount
integer
required

Gross send in Ledger minor units.

stan
string
required

System trace / remittance reference.

beneficiary_id
string<uuid>
required

Recipient beneficiary id.

fee
integer

Customer-visible transfer fee (partner + margin + cross-border).

transfer_fee
integer

Transfer fee component in minor units (same as fee for most corridors).

scheme
string

Corridor scheme used for the send.

country
string

Destination country (ISO 3166-1 alpha-2).

purpose
string

Purpose code submitted with the payout.

purpose_label
string

Human-readable purpose label.

note
string

Free-text note from the request.

invoice_ref
string

Invoice or remittance reference.

quote_id
string<uuid>

Firm FX quote used when currencies differed.

fx_rate
string

Applied FX rate when cross-currency.

recipient_currency
string

Currency credited to the beneficiary.

recipient_amount
integer

Amount the beneficiary receives, in their minor units.

recipient_scale
integer

Decimal places for recipient_currency.

cancellable
boolean

Whether POST /payouts/{id}/cancel can still succeed.

failure_reason
string

Partner or validation failure message when status is failed/rejected.

authorised_at
string<date-time>

When the send was authorised (API key or PIN).

completed_at
string<date-time>

When the payout reached a terminal success state.

created_at
string<date-time>

Creation time (UTC).

updated_at
string<date-time>

Last status change (UTC).