Create account

BETA: This endpoint is subject to change without notice.

Creates a child account under your platform account. Requires ADMIN role and the onboard_accounts capability.

Set parent to your platform account name and provide the account object with type, display_name, contact_email, and capabilities.

Two account types are supported:

  • STANDALONE (independent) — set type to STANDALONE. Must set capabilities.payments.requested to true. Transfers are not supported.
  • EMBEDDED (fund pool member) — set type to EMBEDDED. Must set capabilities.transfers.requested to true. Card payments are not supported. Requires account_holder.country_code (currently only GB) and account_holder.legal_name. The parent account must have balance enabled (a custodial bank account connected).

Returns the created Account. Child accounts start in ACTIVE state. If requires_boarding is true in the response, create a boarding session to collect the remaining account holder details.

Body Params
string
required

Name of the parent account.

Example: "accounts/acct_RwDJsJd8z0exhtfX2570Q"

account
object
Response

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