v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB

Accounts

Get a single account

Retrieve the details of a single account

get/v3/aggregation/accounts/{id}

Path parameters

idnumber required

Example:109456432

Response

Account

idnumber

Account's unique identifier

namestring

Account's name taken from the provider's website

balancenumber

Account's balance

accounting_balancenumber

Accounting balance represents the available money excluding pending and processing transactions

instant_balancenumber

Instant balance represents the expected money on the account including pending and processing transactions

updated_atstring date-time

Timestamp recording when the account was last updated

last_refresh_status'failed' | 'successful'

Indicate if the account was updated successfully or not during the last refresh of the item

Account's type

currency_codestring

3 letters ISO 4217 currency code

item_idnumber

Identifier of the account's item

provider_idnumber

Identifier of the account's provider

proboolean

Flag to indicate that the account is a business account

data_access'enabled' | 'disabled'

User approved access to this account

ibanstring iban

The IBAN of the bank account

Example response

{
  "id": 2341501,
  "name": "Compte Crédit Immobilier",
  "balance": -140200.46,
  "accounting_balance": -140200.46,
  "instant_balance": -140200.46,
  "updated_at": "2024-10-16T07:59:11.785Z",
  "last_refresh_status": "successful",
  "type": "loan",
  "currency_code": "EUR",
  "item_id": 123456789,
  "provider_id": 574,
  "loan_details": {
    "next_payment_date": "2024-12-01",
    "next_payment_amount": 1000,
    "maturity_date": "2035-04-30",
    "opening_date": "2024-11-01",
    "interest_rate": 1.25,
    "type": "mortgage",
    "borrowed_capital": 140200,
    "repaid_capital": 40200,
    "remaining_capital": 100000
  },
  "data_access": "enabled",
  "iban": "FR2420020202260600024M02606"
}