Providers & Branches
List the banks and card issuers you can pay from or connect to, and look up their branches.
Providers & Branches
A provider is a bank or card issuer that Financy can connect to and pay from
(Bank Hapoalim, Leumi, Discount, Cal, Max, Isracard, and so on). It is shared
reference data — the same for every user. Every payment and every connection is
tied to a provider, so this is usually the first reference data you fetch. See
Core Concepts for how providers relate to connections, accounts, and payments.
Use this list to pick aproviderIdfor a payment. Linking a bank
(creating a connection) happens only in the Financy UI, not through the API —see Connections.
All endpoints on this page require a Bearer token — see Authentication.
Failed requests return the standard error shape — see Errors.
| Endpoint | Purpose |
|---|---|
GET /v2/providers | List every provider you can connect to or pay. |
GET /v2/bank-branches | List the branches of a specific bank. |
List providers
GET https://api.open-finance.ai/v2/providers
| Query param | Required | Description |
|---|---|---|
includeFakeProviders | – | true to include sandbox providers. Defaults to false. |
Request
curl "https://api.open-finance.ai/v2/providers" \
-H "Authorization: Bearer <accessToken>"Response
Returns an array of providers:
[
{
"providerFriendlyId": "hapoalim",
"name": "Bank Hapoalim",
"nameNativeLanguage": "בנק הפועלים",
"mode": "PSD2",
"bankCode": 12,
"image": "https://.../hapoalim.png",
"type": "BANK",
"providerForcePaymentService": "masav",
"sortIndex": 1
}
]| Field | Description |
|---|---|
providerFriendlyId | The provider id you pass as providerId / providerIds elsewhere. |
name / nameNativeLanguage | Display name in English and Hebrew. |
mode | Connection mode, e.g. PSD2. |
bankCode | Numeric bank code — use it with GET /v2/bank-branches. |
image | URL of the provider's logo. |
type | BANK, CARD, or INSURANCE. |
providerForcePaymentService | If set (masav / fp / zahav), the payment rail is fixed for this provider. |
sortIndex | Suggested display order (lower = higher priority). |
UseproviderFriendlyId— notbankCode— when you setproviderIdonInitiate a Payment (Direct) or restrict banks with
providerIdson
Create a Payment.
List bank branches
GET https://api.open-finance.ai/v2/bank-branches
Look up the branches of a bank. Useful when an account entry flow needs a branch
number alongside the bank code.
| Query param | Required | Description |
|---|---|---|
bankCode | ✅ | The bank code (the bankCode from GET /v2/providers). |
Request
curl "https://api.open-finance.ai/v2/bank-branches?bankCode=12" \
-H "Authorization: Bearer <accessToken>"Response
Returns an array of branches:
[
{
"bankCode": 12,
"branchCode": 538,
"branchName": "Dizengoff",
"city": "Tel Aviv",
"branchAddress": "Dizengoff 50",
"zipCode": "6433222",
"telephone": "03-0000000"
}
]| Field | Description |
|---|---|
bankCode / branchCode | Identify the bank and the branch. |
branchName / branchType | Branch name and type. |
city / branchAddress / zipCode | Location of the branch. |
telephone / fax / freeTel | Contact numbers. |
mergeBranch / mergeBank | Set when the branch/bank was merged into another. |
See the API Reference for the complete branch object (coordinates,opening/closing dates, accessibility, and more).
Next: learn how a linked bank is represented in Connections.
Updated 7 days ago