Skip to content

Suggested

API Dashboard
Accounts

Accounts represent financial containers that hold and manage funds on behalf of an identity.

Objects

Account object

Unique identifier for the internal service.

Identifier linking the internal account to an organization or user.

External reference identifier for integrations.

CHECKINGASSETSAVINGSESCROWFEE

Indicates the custody type managing the internal account.

Total balance available in the internal account.

Amount of funds available for transactions.

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

A friendly name assigned to the internal account.

Internal reference number for the account.

Name of the entity or user owning the internal account.

The current status of the account (e.g., PENDING, ACTIVE, BLOCKED).

Identifier of the parent account if this is a sub-account.

Details of sub-accounts associated with this internal account.

balancestring/^\d+(\.\d+)?$/required

Total balance of the sub-account.

availableFundsstring/^\d+(\.\d+)?$/required

Funds available for use within the sub-account.

Details of the custody bank account linked to this internal account.

accountNumberstringrequired

The bank account number.

bankstringrequired

The name of the bank where the account is held.

currencystringrequired

Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., CLP, ARS, MXN). Go to the currencies page for the complete list of supported values.

typeAccountstring

The type of bank account. CHECKING_ACOUNT, SAVINGS

countrystringrequired

Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.