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.

EndpointPurpose
GET /v2/data/accountsList 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 paramDescription
connectionIdOnly accounts on this connection.
accountTypeFilter by type: CHECKING, CARD, LOAN, SAVINGS, SECURITY.
includeDuplicates0 (default) or 1 — include accounts seen through duplicate links.
limitMax documents to return.
sort1 ascending, -1 descending.
nextPagePagination 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:

FieldDescription
idAccount id — pass as accountId when filtering Transactions.
connectionIdThe parent Connection.
providerIdThe bank/card issuer (see Providers & Branches).
accountTypeCHECKING, CARD, LOAN, SAVINGS, or SECURITY.
accountNameHuman-readable account name.
accountNumber / parsedAccountRaw number, and the parsed { bank, branch, number }.
currencyAccount currency, e.g. ILS.
balancesArray of { amount, currency } — see Balances below.
creditLimit / cardDueDate / creditStatusCard-specific fields.
interestInterest details — savings and loans only.
ownerInfo{ nationalId, fullName } of the account owner.
transactionsNumber 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"
  }
]
FieldDescription
balanceTypeWhich kind of balance this is (see the table below).
balanceAmountThe value: { amount, currency }.
creditLimitIncludedWhether the amount includes the account's credit limit.
referenceDateThe date the balance refers to (e.g. loan origination), when given.

Balance types

balanceTypeMeaning
closingBookedEnd-of-reporting-period balance: opening balance + all entries booked in the period.
expectedBooked entries + known pending items; a projection of the end-of-day balance.
interimAvailableAvailable balance computed during the business day (subject to change).
interimBookedInterim balance from entries already booked during the calculation window.
forwardAvailableAvailable balance at a specified future date.
openingBookedOpening balance (previous report's closing balance). Not used in the Israeli market.

Which types appear depends on the accountType:

  • CHECKING — all types; closingBooked is always present.
  • CARD — mainly closingBooked, interimBooked, interimAvailable (meanings vary by card subtype).
  • SAVINGSclosingBooked and expected.
  • LOANclosingBooked, expected, interimBooked.
📘

There is no separate balance-history endpoint. balances are the account's

current balances; to reconstruct balances over time, read Transactions
each transaction carries balancePerEndDay.

Next: read the money movements on an account in Transactions.


Did this page help you?