Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Idempotency-Key
string

Optional idempotency key. When supplied, a retry with the same key replays the original response (24h TTL) instead of being rejected as a duplicate.

Body

application/json
customerId
string
required

Customer ID

Example:

"cus_abc123"

product
enum<string>

Balance product. STANDARD holds fiat USD. YIELD holds a reserve-backed token that can earn configurable yield. Defaults to STANDARD.

Available options:
STANDARD,
YIELD
Example:

"STANDARD"

externalReference
string

Client-provided external reference

Example:

"550e8400-e29b-41d4-a716-446655440000"

metadata
object

Additional metadata

Example:

Response

Balance account created successfully

id
string
required

Account ID (vba_xxx for virtual bank, vwa_xxx for virtual wallet, inb_xxx for infinite bank, inw_xxx for infinite wallet, eba_xxx for external bank, ewa_xxx for external wallet, pba_xxx for provider balance)

Example:

"vba_1234567890abcdef"

customerId
string
required

Customer ID

Example:

"cust_abc123"

type
enum<string>
required

Account type

Available options:
VIRTUAL_BANK,
VIRTUAL_WALLET,
INFINITE_BANK,
INFINITE_WALLET,
EXTERNAL_BANK,
EXTERNAL_WALLET,
EXTERNAL_PROXY,
PROVIDER_BALANCE
Example:

"VIRTUAL_BANK"

status
enum<string>
required

Account status

Available options:
IN_REVIEW,
ACTIVE,
CLOSED
Example:

"ACTIVE"

createdAt
string<date-time>
required

Account creation date

Example:

"2026-01-15T10:00:00Z"

updatedAt
string<date-time>
required

Account last update date

Example:

"2026-01-15T10:00:00Z"

externalReference
string

Client-provided external reference for mapping to your system

Example:

"550e8400-e29b-41d4-a716-446655440000"

bankDetails
object

Bank account details (for bank accounts)

walletDetails
object

Wallet details (for wallet accounts)

currencyCodes
string[]

Currency codes supported by this account

Example:
virtualBankAccount
object

Virtual bank account details

virtualWallet
object

Virtual wallet details (also known as liquidation addresses)

proxyDetails
object

Proxy account details (for proxy/alias-based accounts like PIX, UPI, PromptPay)

isThirdParty
boolean

Is this account owned by a third party?

Example:

false

counterpartyId
string | null

Counterparty ID when this is a third-party recipient account

Example:

"cp_abc123"

referenceId
string

Client-provided reference ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

originCapable
boolean | null

Whether this account can be used as the canonical transfer origin.

Example:

true

originAccountId
string | null

Canonical origin account ID when this account is a virtual alias.

Example:

"vba_1234567890abcdef"

metadata
object

Additional metadata

created
boolean

Whether this account was newly created in this request. Returns false if an existing account was returned (idempotent behavior).

Example:

true

holdsBalance
boolean

Present and true when this is a balance account (USD or stablecoin). Deposits credit the account instead of being swept, and the balance can fund transfers. See GET /v1/accounts/{id}/balance.

Example:

true

paymentRail
string

Payment rail for provider balance accounts (e.g. ETHEREUM). Omitted for other account types.

Example:

"ETHEREUM"

lastSentAt
string<date-time>

Timestamp of the last transfer sent from this account

Example:

"2024-01-15T10:30:00Z"

lastReceivedAt
string<date-time>

Timestamp of the last transfer received to this account

Example:

"2024-01-15T10:30:00Z"

customer
object

Expanded customer details (only included when expand=customer)

sweepTargetAccount
any

Expanded sweep target account details (only included when expand=sweepTargetAccount). For virtual bank accounts and virtual wallets that sweep to an external account.

counterparty
object

Expanded counterparty details (only included when expand=counterparty)