Accounts & Balances
List a user's accounts and read their balances and details.
Accounts & Balances
An account is one financial product inside a Connection — a single
checking account, credit card, savings account, loan, or securities account at
the linked bank. A connection typically holds several accounts, and each account
carries its own current balances (a connection does not — see the
distinction in Core Concepts).
Accounts appear only after the user has linked a bank in the Financy UI(connections cannot be created via the API). If a user has no accounts, they
have not linked a bank yet — see Connections.
All endpoints require a Bearer token — see Authentication. Failed requests
return the standard error shape — see Errors.
| Endpoint | Purpose |
|---|---|
GET /v2/data/accounts | List the user's accounts. |
GET /v2/data/accounts/{accountId} | Read one account in full. |
List accounts
GET https://api.open-finance.ai/v2/data/accounts
| Query param | Description |
|---|---|
connectionId | Only accounts on this connection. |
accountType | Filter by type: CHECKING, CARD, LOAN, SAVINGS, SECURITY. |
includeDuplicates | 0 (default) or 1 — include accounts seen through duplicate links. |
limit | Max documents to return. |
sort | 1 ascending, -1 descending. |
nextPage | Pagination cursor from the previous response. |
Request
curl "https://api.open-finance.ai/v2/data/accounts?connectionId=01J8CONN...&accountType=CHECKING" \
-H "Authorization: Bearer <accessToken>"Response
{
"nextPage": null,
"items": [
{
"id": "01J8ACC...",
"connectionId": "01J8CONN...",
"providerId": "hapoalim",
"accountType": "CHECKING",
"accountName": "Everyday",
"currency": "ILS",
"balances": [{ "amount": 4210.55, "currency": "ILS" }],
"transactions": 214
}
]
}The list wraps accounts in { nextPage, items }. Pass nextPage back to page
through results.
Get an account
GET https://api.open-finance.ai/v2/data/accounts/{accountId}
curl "https://api.open-finance.ai/v2/data/accounts/01J8ACC..." \
-H "Authorization: Bearer <accessToken>"Key fields on an account:
| Field | Description |
|---|---|
id | Account id — pass as accountId when filtering Transactions. |
connectionId | The parent Connection. |
providerId | The bank/card issuer (see Providers & Branches). |
accountType | CHECKING, CARD, LOAN, SAVINGS, or SECURITY. |
accountName | Human-readable account name. |
accountNumber / parsedAccount | Raw number, and the parsed { bank, branch, number }. |
currency | Account currency, e.g. ILS. |
balances | Array of { amount, currency } — see Balances below. |
creditLimit / cardDueDate / creditStatus | Card-specific fields. |
interest | Interest details — savings and loans only. |
ownerInfo | { nationalId, fullName } of the account owner. |
transactions | Number of transactions on the account. |
Balances
An account exposes a balances array — a bank typically reports the same
account under more than one balance type (e.g. the booked end-of-day balance
and the amount available right now). Each entry looks like:
"balances": [
{
"balanceType": "closingBooked",
"balanceAmount": { "amount": 4210.55, "currency": "ILS" },
"creditLimitIncluded": false,
"referenceDate": "2026-01-04"
}
]| Field | Description |
|---|---|
balanceType | Which kind of balance this is (see the table below). |
balanceAmount | The value: { amount, currency }. |
creditLimitIncluded | Whether the amount includes the account's credit limit. |
referenceDate | The date the balance refers to (e.g. loan origination), when given. |
Balance types
balanceType | Meaning |
|---|---|
closingBooked | End-of-reporting-period balance: opening balance + all entries booked in the period. |
expected | Booked entries + known pending items; a projection of the end-of-day balance. |
interimAvailable | Available balance computed during the business day (subject to change). |
interimBooked | Interim balance from entries already booked during the calculation window. |
forwardAvailable | Available balance at a specified future date. |
openingBooked | Opening balance (previous report's closing balance). Not used in the Israeli market. |
Which types appear depends on the accountType:
- CHECKING — all types;
closingBookedis always present. - CARD — mainly
closingBooked,interimBooked,interimAvailable(meanings vary by card subtype). - SAVINGS —
closingBookedandexpected. - LOAN —
closingBooked,expected,interimBooked.
There is no separate balance-history endpoint.balancesare the account'scurrent balances; to reconstruct balances over time, read Transactions —
each transaction carriesbalancePerEndDay.
Next: read the money movements on an account in Transactions.
Updated 7 days ago

