Accounts

View as Markdown
Current, savings and other cash accounts, with their balances and transactions. Each account carries its identifiers (IBAN and the source's own), currency, balances, holders and the transactions retrieved. Field by field — including the categories every transaction arrives with — in [Accounts](/guides/data-models/banking/accounts). <Note title="Requires the `accounts_read` feature"> Features are chosen when the execution **starts**, not here. An execution that did not ask for `accounts_read` answers `204`, and the only way to get the data is to run another one. **Transactions and holders are opt-in**: `read_transactions` and `read_holders` both default to `false`, so a run that did not ask for them returns the accounts with balances and nothing else. How far back the movements go is decided by `from_date` / `to_date` and by what the institution allows — [Show engine details](api:GET/config/engines/{engine_reference}) states the limits of each engine. </Note> | Status | Meaning | | :--- | :--- | | `200` | The accounts, each with the transactions retrieved for it. | | `202` | `feature_not_ready` — `accounts_read` is still running. **Only this family waits**: the ones that already closed answer now. | | `204` | The execution never asked for `accounts_read`. No body. | | `404` | No execution with that id for your application, or it has been deleted. | <Note> **Server to server only.** This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read. </Note>

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
Every cash account the source reported — current, savings and the rest — each with its identifiers, currency, balances, holders and the transactions retrieved.

An empty list is an answer, not a gap: the feature ran and the source reported none.

idstringformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"financial_account"
sub_family"financial_account:current"
fetch_datestringformat: "datetime"
Date this product was fetched
data_enrichmentenum
Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data.
identifierobject
Account identifier
customer_segmentenum
product_namestring
Product name
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
opening_datedateOptional
Account opening date
transactionslist of objectsOptional
Account transactions
holderslist of objectsOptional
Account holders
availableobjectOptionalDeprecated
The total accessible funds, considering all cleared and uncleared transactions. This represents the amount a user can use or withdraw immediately.
bookedobjectOptionalDeprecated
The net monetary amount without considering pending transactions. It reflects the actual balance at any given moment.

Errors

404
Not Found Error
422
Unprocessable Entity Error