Request a payout from one of your balances to the balance's configured bank account.
The payout will be executed on the next scheduled business day. If no amount is specified, the full available balance minus any configured balance reserve is paid out.
Once the payout is created with status requested, you can cancel it via the Cancel payout endpoint, up until the payout moves to initiated.
Creating a payout via the API automatically sets the balance's transferFrequency to never, pausing any previously configured automatic settlement schedule. To resume automatic settlements, update the transfer frequency via the dashboard.
Webhooks
Subscribe to the following webhook events to track payout status changes. See the Webhook Subscriptions API for details on subscribing.
| Event | Description |
|---|---|
payout.initiated | The payout is being executed and funds are reserved. |
payout.processing-at-bank | The payout has been submitted to the bank. |
payout.completed | The payout has been sent to the destination bank account. |
payout.canceled | The payout was canceled via the API before being submitted to the bank. |
payout.failed | The payout failed after creation, including bank rejections and post-submission cancellations. |
Payout failure reasons
A payout request may fail immediately if one of the following conditions applies:
- A payout is already scheduled for the next business day for this balance.
- The balance has insufficient funds.
- The balance is not active.
- Payouts are blocked for this organization.
- The balance has queued refunds.
- One of the organization's balances is below the negative balance threshold.
- The payout destination (bank account) is invalid or not configured.