Connections

A connection represents one bank a user has linked to Financy — the
authorized link to that bank, not the money inside it. One connection exposes
several Accounts, and each account has its Transactions. Once a
connection exists, that data becomes readable through the API.

📘

New to the model? Core Concepts defines every entity and explains the

connection vs. account distinction in full.

⚠️

Connections can be created only through the Financy UI — never via the
API. Users link a bank through the hosted consent journey (or as part of a

payment flow). This API lets you list, read, refresh, and delete
connections; there is no create endpoint — bank linking requires the
interactive consent journey.

If you need to create connections programmatically (e.g. to aggregate your
customers' data at scale), that's available on the Open Finance platform,
our B2B product — contact us to get access.

All endpoints require a Bearer token — see Authentication. Failed requests
return the standard error shape — see Errors (deleting a connection can also
return 423 Locked).

List connections

GET https://api.open-finance.ai/v2/connections

Request

curl "https://api.open-finance.ai/v2/connections?status=ACTIVE&limit=20" \
  -H "Authorization: Bearer <accessToken>"

Response

{
  "count": 1,
  "nextPage": null,
  "items": [
    {
      "id": "01J8CONN...",
      "providerId": "hapoalim",
      "status": "ACTIVE",
      "mode": "PSD2",
      "accounts": 2,
      "cards": 1,
      "savings": 0,
      "loans": 0,
      "transactions": 431,
      "expiryDate": "2026-10-01T00:00:00.000Z",
      "createdAt": "2026-07-01T09:12:00.000Z"
    }
  ]
}

Get a connection

GET https://api.open-finance.ai/v2/connections/{connectionId}

curl "https://api.open-finance.ai/v2/connections/01J8CONN..." \
  -H "Authorization: Bearer <accessToken>"

Key fields on a connection:

Status values

💡

CONNECTED, ACTIVE, and COMPLETED mean data is readable. ACTIVE stays

on the automatic refresh schedule; COMPLETED was a single fetch and will
not update. Treat every other status as "cannot read fresh data right now"
and, once consent has EXPIRED / been REVOKED, prompt the user to reconnect
in the Financy UI.

Refresh connections

POST https://api.open-finance.ai/chat/chat/connections/refresh

Triggers an on-demand refresh of every refreshable connection the user has,
independent of the automatic schedule. This is the same "Refresh now" action
offered in the Financy UI.

Automatic refresh is plan-dependent, not a flat 6-hour pull for everyone.
The aggregation cron ticks every 6 hours starting in the morning
(Asia/Jerusalem). Each plan spends its daily allowance across those ticks:

• Free / Starter — one automatic pass, in the morning.
• Pro — four automatic passes (every 6 hours from the morning).
• Starter can add extra daily slots in Settings (up to four/day).

On-demand refresh does not consume that daily allowance.

⚠️

Different base path — and the doubled /chat is real. The refresh

endpoint is served by the chat API Gateway, not /v2. That gateway is
mounted at https://api.open-finance.ai/chat (basePath: chat) and the
route itself is /chat/connections/refresh, so the public URL is
https://api.open-finance.ai/chat/chat/connections/refresh. A request to
/chat/connections/refresh (one /chat) is 404. Authentication is
unchanged: the same OAuth2 client-credentials Bearer token, with the
read:connections scope.

A flat 20 credits are charged on accept — debited from the organization's
credit balance, separate from the daily update quota. The call enqueues and
returns immediately (it does not wait for the banks); poll each connection's
lastFetchedAt to detect completion, typically within 1–2 minutes. A refresh
already in flight returns 200 with already_running and is not charged again.

Request

curl -X POST "https://api.open-finance.ai/chat/chat/connections/refresh" \
  -H "Authorization: Bearer <accessToken>"

Responses

Delete a connection

DELETE https://api.open-finance.ai/v2/connections/{connectionId}

Removes the connection for the current user.

curl -X DELETE "https://api.open-finance.ai/v2/connections/01J8CONN..." \
  -H "Authorization: Bearer <accessToken>"

Next: read the balances and details of a connection's Accounts.