Field | Description |
---|---|
id long | Account's unique identifier. |
resource_uri string | |
resource_type string, constant | |
name string | Account's name taken from the bank's website. |
balance double | Account's balance. |
status integer | Detailed on the Items status page. |
status_code_info string | Detailed on the Items status page. |
status_code_description string | Detailed on the Items status page. |
updated_at timestamp | Timestamp recording when the account was last refreshed. |
type string | Account's type. See table below. |
currency_code string | 3 letters ISO 4217 currency code. |
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. ℹ️ 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. ℹ️ Support for this information varies depending on the account's bank. |
is_pro boolean | Flag to indicate that the account is a business bank account. |
iban iban | The IBAN of the bank account. ℹ️ Support for this information varies depending on the account's bank. |
Example account resource
{
"id": 123456,
"resource_uri": "/v2/accounts/123456",
"resource_type": "account",
"name": "Compte Crédit Immobilier",
"balance": 140200,
"status": 0,
"status_code_info": null,
"status_code_description": null,
"updated_at": "2019-05-06T03:31:58Z",
"type": "home_mortgage",
"currency_code": "EUR",
"item": {
"id": 789123,
"resource_uri": "/v2/items/789123",
"resource_type": "item"
},
"bank": {
"id": 408,
"resource_uri": "/v2/banks/408",
"resource_type": "bank"
},
"loan_details": null,
"savings_details": null,
"is_pro": false,
"iban": "FR2420020202260600024M02606"
}
ACCOUNT TYPES
Type | Description |
---|---|
checking | Checking account. |
savings | Savings account. |
securities | Securities account. |
card | Credit or debit card. |
loan | Loan. |
share_savings_plan | French 'PEA', Plan d'Epargne en Actions. |
pending | A virtual account that contains all the pending transactions. |
life_insurance | Life insurance. |
special | Temporary type. Set while the account is synchronizing. |
unknown | Unknown. |
COMPLEMENTARY RESOURCES
Loan details
Field | Description |
---|---|
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
Field | Description |
---|---|
opening_date date | Date when the account was opened. |
interest_rate double | Account's interest rate. |
ceiling double | Maximum amount on the account. |