Create payout

Required capability: payouts

BETA: This endpoint is subject to change without notice.

Initiates a payout from the account's available balance to a registered external bank account.

Provide external_bank_account_name, currency (ISO-4217), and amount in minor units. The external bank account must belong to the same account and its currency must match. The amount is reserved from the available balance immediately — the request fails if insufficient funds are available.

The payout is created in REQUIRES_APPROVAL state. Once approved, it transitions to PENDING and is submitted for processing.

Returns the created Payout.

Path Params
string
required
Body Params
payout
object
required
Response

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