Account Object

An Account represents a bank account retrieved from a connected institution. Each account includes balance information, account details, and the institution it belongs to.

Attributes

Field	Type	Description
id	string	Unique identifier for the account. Format: `acc_ULID`
connectionId	string	ID of the parent connection
name	string	Account name as provided by the bank (e.g., "Cuenta Corriente")
type	string	Account type: `checking`, `savings`, `credit_card`, `line_of_credit`
currency	string	ISO 4217 currency code (e.g., `CLP`, `USD`)
balance	number	Current balance in the smallest currency unit (e.g., pesos for CLP)
availableBalance	number	Available balance (may differ from balance due to pending transactions or holds)
accountNumber	string \| null	Account number as provided by the bank
createdAt	string	ISO 8601 timestamp when the account was first synced
lastSyncedAt	string \| null	ISO 8601 timestamp of the last successful sync
institution	object \| null	Institution details (id, name, logo) for the bank this account belongs to

Institution Object

The institution field contains:

id - Institution identifier (e.g., cl_banco_estado)
name - Display name of the institution
logo - URL to the institution's logo (if available)

Example

json

              {
  "id": "acc_01HQ3K5J7X8Y9Z0A1B2C3D4E5F",
  "connectionId": "conn_01HQ3K5J7X8Y9Z0A1B2C3D4E5F",
  "name": "Cuenta Corriente",
  "type": "checking",
  "currency": "CLP",
  "balance": 1250000,
  "availableBalance": 1150000,
  "accountNumber": "123456789",
  "createdAt": "2024-01-15T10:30:00Z",
  "lastSyncedAt": "2024-01-15T14:30:00Z",
  "institution": {
    "id": "cl_banco_estado",
    "name": "Banco Estado",
    "logo": null
  }
}
            