FieldDescription
id
long
Account's unique identifier.
name
string
Account's name taken from the bank's website.
balance
double
Account's balance.
currency_code
string
3 letters ISO 4217 currency code.
status
integer
Account's item status' code.
type
string
Account's type. See table below.
updated_at
timestamp
Timestamp recording when the account was last refreshed.
item
item hash
Mini item representation of the account's item.
bank
bank hash
Mini bank representation of the account's bank.
loan_details
loan details hash
The complementary details for a loan account.
See table below for more information.

:information-source: Support for this information varies depending on the account's bank.
savings_details
savings details hash
The complementary details for a savings account.
See table below for more information.

:information-source: Support for this information varies depending on the account's bank.
resource_type
string, constant
resource_uri
string
Example account resource
{
  "id": 123456,
  "name": "Compte Crédit Immobilier",
  "balance": 140200,
  "currency_code": "EUR",
  "status": 0,
  "type": "home_mortgage",
  "updated_at": "2016-05-06T03:31:58Z",
  "item": {
    "id": 789123,
    "resource_uri": "/v2/items/789123",
    "resource_type": "item"
  },
  "bank": {
    "id": 408,
    "resource_uri": "/v2/banks/408",
    "resource_type": "bank"
  },
  "resource_uri": "/v2/accounts/123456",
  "resource_type": "account",
  "loan_details": null,
  "savings_details": null
}

ACCOUNT TYPES

TypeDescription
checkingChecking account.
savingsSavings account.
securitiesSecurities account.
cardCredit or debit card.
loanLoan.
share_savings_planFrench 'PEA', Plan d'Epargne en Actions.
pendingA virtual account that contains all the pending transactions.
life_insuranceLife insurance.
specialTemporary type.
Set while the account is synchronizing.
unknownUnknown.

COMPLEMENTARY RESOURCES

Loan details

FieldDescription
next_payment_date
date
Date when the next payment is owed.
next_payment_amount
double
Amount owed for the next payment.
maturity_date
date
Predicted end of the loan's refunding.
opening_date
date
Date when the loan was contracted.
interest_rate
double
Loan's interest rate.
type
string
Loan type (ex. : mortgage).
borrowed_capital
double
Amount of capital that was borrowed.
repaid_capital
double
Amount of capital that has already been repaid.
remaining_capital
double
Amount of capital left to repay.

Savings details

FieldDescription
opening_date
date
Date when the account was opened.
interest_rate
double
Account's interest rate.
ceiling
double
Maximum amount on the account.