Skip to main content
POST

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Path Parameters

organizationId
string<uuid>
required

The organization this call acts for: your API key's organization or one of its customer organizations. Any other id returns 404 not-found.

Body

application/json
kind
enum<string>
required

The kind of account. embeddedWallet is a wallet we create on a chain; see Embedded wallets. debitCard and cash return 422 unsupported.

Available options:
bank,
wallet,
embeddedWallet,
debitCard,
cash
label
string
required

Your organization's name for the account. Must not be blank. We trim it.

Example:

"Operating account"

accountDetails
clabe · object
required

The identifier that names the account, tagged by kind. The kind decides the field set: send exactly the fields your kind declares. A missing field or a field the kind does not declare returns 400 validation-error with a pointer per field.

country
string

Two-letter country code of the account's market. Send with currency for a bank account. Omit for a wallet.

Example:

"MX"

currency
string

Three-letter currency code of the account's market. Send with country for a bank account. Omit for a wallet.

Example:

"MXN"

registrationInfo
object

Account holder information a bank account route requires. The route and the organization's account type (personal or business) decide which fields are required: accountHolderName and taxId for bank accounts, plus the personal or business fields on routes that need them. We fill a field from the organization's verified identity when we hold it, so you only need to send the fields a registration-info-required problem lists in missing. You may send other registration fields too: we check their format and ignore the ones the route does not use. A name that is not listed here returns 400 validation-error. Wallets require no fields.

Response

The organization already holds this account. Returns it. A rejected direction is registered again and returns as pending.

id
string<uuid>
required
status
enum<string>
required

The account as a whole. ready when any rail direction is ready. rejected when every rail direction is rejected; register the account again with corrected registrationInfo to retry. disabled when we turned the account off; it cannot be registered or quoted. Otherwise pending. Readiness per rail and direction is in rails.

Available options:
pending,
ready,
rejected,
disabled
label
string
required

Your organization's name for the account.

rails
object
required

The rails this account can move money on, keyed by rail name (a PaymentRail value such as spei or stellar). A rail the account cannot move money on is absent. The account identifier you registered is not returned.

createdAt
string<date-time>
required