Account object

The Account object

An Account represents a single bank account held by a user at a financial institution, including its type, holder, currency, and balance. It appears within the accounts array of a Link and reflects the data retrieved from the institution on the last refresh.

{
  "id": "acc_nMNejK7BT8oGbvO4",
  "object": "account",
  "balance": {
    "available": 500000,
    "current": 500000,
    "limit": 500000
  },
  "currency": "CLP",
  "holder_id": "111111111",
  "holder_name": "Jon Snow",
  "name": "Cuenta Corriente",
  "next_refresh": "2020-11-18T22:43:54.591Z",
  "number": "9530516286",
  "official_name": "Cuenta Corriente Moneda Local",
  "refresh_status": "refreshing",
  "refreshed_at": "2020-11-18T18:43:54.591Z",
  "removed_from_link": false,
  "type": "checking_account"
}

Attribute	Type	Description
`id`	`string`	Unique identifier for the Account
`object`	`string`	Identifier for the type of object. Its value for `Account` will always correspond to `account`
`balance`	`object`	Account balance
`currency`	`string`	Currency ISO code
`holder_id`	`string`	Account owner's tax ID. In Chile, this value is a Chilean tax ID (RUT). In Mexico, this value is a Mexican tax ID (RFC).
`holder_name`	`string`	Name of the owner of the account
`name`	`string`	Standardized name of the account
`next_refresh`	`string`	`Account`'s next update date using ISO 8601. If the account is removed, it will be `null`
`number`	`string`	Account number. Does not include hyphens nor prefixed zeros
`official_name`	`string`	Name of the account used by the institution
`refresh_status`	`string`	Status of the `Account`. It can take the values: `starting`, `refreshing` or `interrupted`.
`refreshed_at`	`string`	`Account`'s last update date, using ISO 8601. If the account has never been updated, it will be `null`
`removed_from_link`	`boolean`	Is `true`when the `Account` has been removed from the `Link`. Else is `false`.
`type`	`string`	Type of account. Learn more by looking at the available account types table below

The Balance object

The Balance object holds the monetary amounts for an account. It appears in the balance field of the Account object.

Attribute	Type	Description
`available`	`integer`	Available amount in the account, according to the bank. When looking at accounts with types within `checking_account`, `savings_account`, `sight_account` and `rut_account`, the `available` attribute does not include the amount of money that the line of credit provides (if it exists). When looking at accounts with type `line_of_credit`, generally the `available` attribute value is equal to the limit of the line of credit, minus the accounting amount
`current`	`integer`	Accounting amount of the Account
`limit`	`integer`	When looking at accounts with types within `checking_account`, `savings_account`, `sight_account` and `rut_account`, the `limit` attribute is equal to the available amount plus the amount available on the associated line of credit (if it exists). When looking at accounts with type `line_of_credit`, the `limit` attribute corresponds to the approved amount for that line of credit

🚧
Note
For Santander accounts with type checking_account, the used amount from the line of credit will be deducted from the available amount

Account types

Type	Description
`checking_account`	Checking account
`savings_account`	Savings account
`sight_account`	Sight account
`line_of_credit`	Line of credit
`credit_card`	Credit card