Create external bank account

Required capability: payouts

BETA: This endpoint is subject to change without notice.

Registers an external bank account for receiving payouts.

Provide country, currency, account_holder_name, account_holder_type, and bank details using the appropriate scheme: gb_bank_details (sort code and account number), iban_bank_details (IBAN), or us_bank_details (routing number and account number).

Verification is performed automatically on creation (e.g. Confirmation of Payee for UK accounts). The account transitions to ACTIVE once verified, at which point it can be used for payouts. If verification fails, the account remains in REQUIRES_VERIFICATION state — create a new external bank account with corrected details.

Path Params
string
required
Body Params
external_bank_account
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