Sign in

v3

OpenAPI 3.0.32026-08-07179327431.7 KB
money
payouts

Cancel bank payout

Attempts to cancel a bank payout. THE WINDOW IS NARROW AND IT IS NOT OURS: the payout rail only accepts a cancellation while the payout is still pending or held at the partner. Once it has been sent on to the beneficiary's bank it cannot be recalled, and this endpoint fails with payout_not_cancellable rather than pretending otherwise. A payout that has not yet been handed to the rail also cannot be cancelled (payout_not_submitted) — retry once it is processing. On success the payout's status settles to failed once the rail's cancellation is reconciled, which is not instantaneous: the status returned here still reflects the ledger as it currently stands. Gated on PermKYBLocked + PermFundsWithdraw.

post/money/payouts/{id}/cancel

Path parameters

idstring required

Headers

Idempotency-Keystring

Optional client idempotency key, honored if sent: a duplicate submission with the same key is rejected with 409 instead of reaching the payout rail twice.

Optional client idempotency key, honored if sent: a duplicate submission with the same key is rejected with 409 instead of reaching the payout rail twice.

Response

OK

completed_tsstring date-time
created_tsstring date-time
failed_tsstring date-time
idstring
input_amountstring
input_symbolstring
output_amountstring
output_symbolstring
purpose'supplier' | 'payroll' | 'physical_goods' | 'digital_goods' | 'other_services' | 'property_rental' | 'logistics' | 'taxes' | 'insurance' | 'remittances' | 'investment' | 'charity_donation' | 'tuition_costs' | 'medical_care' | 'family_maintenance' | 'pension' | 'utility_provider' | 'public_services' | 'property_purchase' | 'travel' | 'tourism_expense' | 'entertainment' | 'affiliation_programs' | 'rewards' | 'savings_retirement' | 'investment_interest' | 'shares' | 'availability' | 'capital_contribution'
status'pending' | 'processing' | 'paid' | 'failed' required