Skip to main content
POST
Register External Account

Authorizations

X-API-KEY
string
header
required

Headers

X-Step-Up-Token
string

Step-up token required for Bearer/session auth (ignored for API-key auth)

Body

application/json

body

currencies
string[]
required

Currencies this account can receive. A Fiat account takes exactly one.

Minimum array length: 1
Example:
name
string
required

Display name.

Maximum string length: 255
Example:

"Treasury (Base)"

reference
string
required

Merchant's own reference. Payouts can name this account by it.

Maximum string length: 255
Example:

"treasury-base"

type
enum<string>
required

Kind of destination, mirroring our currency_type enum: Digital (a wallet) or Fiat (a bank account).

Available options:
Digital,
Fiat
Example:

"Digital"

account_holder_name
string

Name on the bank account. Fiat only, required.

account_number
string

Bank account number or IBAN. Fiat only, required. Encrypted at rest; only a hint is ever returned.

address
string

Destination wallet address. Digital only, required.

bank_name
string

Name of the beneficiary bank. Fiat only.

beneficiary_type
enum<string>

Who owns the bank account. Fiat only; defaults to business.

Available options:
individual,
business
business_name
string

Beneficiary business name. Fiat only; defaults to account_holder_name for a business.

chain_id
integer

Chain id. Digital only, required.

Example:

8453

country
string

ISO 3166-1 alpha-2 country of the bank account. Fiat only, required.

Example:

"DE"

first_name
string

Beneficiary first name. Fiat only, required when beneficiary_type is individual.

last_name
string

Beneficiary last name. Fiat only, required when beneficiary_type is individual.

payment_rail
enum<string>

Payment rail to settle on. Fiat only; defaults to SEPA.

Available options:
SEPA,
SEPA_INSTANT

Response

Created

data
object

Response payload when the request succeeded.

error
boolean

True when the request failed.

message
string

Human-readable status or error message.