Bank Accounts
Connect a Bank in the Panel

Connect a Bank in the Panel

Connecting your bank is done only in the panel. This page describes the steps in the panel. Once the connection is active, you can see your accounts in the panel and read them through the API.

In the panel, banks live under the Banka Bağlantıları (Bank Connections) product:

ScreenUsed for
Bankalar (Banks)Your connected banks, total assets, bank details and statements. → Banks and Statements
Entegrasyonlar (Integrations)Picking a bank and starting a connection or an application.
Başvuru formu (Application form)Applying to several banks at once.
Hesaplar (Accounts)All your accounts.
Hareketler (Transactions)The transactions of all your accounts.

The list of banks you can connect: Banks › Supported banks.

Required panel permissions

ActionPanel permission
See banks, the application form and accountsbank-connect:view
Start a connection or an application, enter bank details, disconnectbank-connect:manage
See balances and transactions, download statementsbank-connect:transactions:view

If you lack a permission, the screen tells you which one is required; you can ask your organization administrator for it.

Choose the environment

Use the Environment selector at the top of the screens to choose Test or Live. The connection is opened in the selected environment and can only be read with an API key of that environment. In the test environment only simulator banks are listed and no real bank is contacted. → Test Environment

The Integrations screen

You start connecting a bank on Banka Bağlantıları › Entegrasyonlar (Bank Connections › Integrations). If you have no connected bank yet, the Go to integrations button on the Bankalar (Banks) screen also brings you here.

On this screen you can search banks by name or EFT code. Each bank's card shows the status of your connection:

Card statusMeaningConnection status in the API
AvailableYou can connect this bank with Lunixi.— (no connection)
Coming soonConnections to this bank are not yet supported in this environment.—
Documents pendingYour application documents are pending.PENDING_DOCUMENTS
Under reviewYour documents are under review.UNDER_REVIEW
Setup pendingLunixi is completing the setup.PENDING_SETUP
ConnectedYour accounts are read regularly.ACTIVE
Reading delayedRecent reads failed; data may be out of date.DEGRADED
SuspendedNo reads are performed.SUSPENDED

Connect a bank

Pick the bank and apply

On the Integrations screen, click Connect with Lunixi on the card of the bank you want to connect. Depending on the bank, the dialog may ask for extra details, for example your IBANs at this bank (one IBAN per line). The requested fields differ per bank. Connect with Lunixi creates your application.

Deliver the application document to your branch

If the bank requires application documents, they are listed in the dialog and in the connection details. For each document, download the form with Download sample form, fill it in and sign it. Deliver the wet-signed application document to your branch; the delivery instruction under each document says where it goes. Your documents are marked in the panel once they are received.

If a document is rejected, the reason appears in the connection details; correct the document and deliver it again.

Enter the details provided by your bank

Once your bank has processed your application, it sends you the API details for the connection. Enter them in the Details provided by your bank section of the connection details. → Details provided by your bank

Wait for the setup

Lunixi's team completes the setup. When the bank starts being read, the connection becomes active, the card shows Connected and your accounts are listed automatically on the Bankalar (Banks) and Hesaplar (Accounts) screens. If your bank becomes readable, the connection becomes active even if the application steps are not yet complete.

Details provided by your bank

After you deliver the wet-signed application to your branch, your bank sends you the API details for the connection. Enter them as follows:

  1. On the Integrations screen, click Details on the bank's card.
  2. In the Details provided by your bank section, click Enter details.
  3. Fill in the fields your bank sent you and click Save.

Good to know:

  • The requested fields differ per bank; the section appears only for banks that require these details.
  • The section opens once the connection reaches the Setup pending step; you can also update the details while the connection is Connected or Reading delayed.
  • The details are stored encrypted. After saving, the values are never shown again for security reasons; the section only shows Entered and the time of entry.
  • To change the details, click Update details. Fields you leave blank keep their current value; you only need to enter the fields you change.
  • Entering the details requires the bank-connect:manage permission.

The first read

Once the connection is active, your accounts, balances and transactions start being read from the bank.

  • On the first connection, the transactions of the last 30 days are read. These past transactions load in parts within a few minutes; it is normal for the list to be incomplete during the first minutes.
  • After that, accounts are read from the bank regularly, at most every 5 minutes. → Limits › Freshness and the read interval
  • No webhooks are sent for the past transactions read on the first connection. → Webhook Events

Apply to several banks at once

To connect several banks at the same time, use Banka Bağlantıları › Başvuru formu (Application form):

  1. Select the banks. Banks you already have a connection or application with, and banks not supported in this environment, cannot be selected. Connect banks that ask for connection details (e.g. an IBAN list) one by one on the Integrations screen.
  2. Review the required documents. The documents requested by the selected banks are shown in a single list; a document requested by several banks is listed once, with the banks it is requested for. Download the sample forms, fill them in and deliver them as the delivery instructions say.
  3. Start the application. A separate connection is opened for each selected bank. The result screen shows how many applications were created and which ones could not be opened and why.

The next steps run separately for each bank: delivering the document to the branch, entering the details provided by your bank and the setup.

The application process

Until the connection is active, the application goes through these steps. The same status appears in the connection's status field in the API:

Bank connection application processProcess: for a bank that requires documents the application starts at Documents pending (PENDING_DOCUMENTS); once you deliver the document to your branch it is Under review (UNDER_REVIEW) and returns if a document is rejected; it then becomes Setup pending (PENDING_SETUP), where you enter the details your bank sent and Lunixi completes the setup, and finally Connected (ACTIVE). Banks without documents start at Setup pending.DELIVEREDREJECTEDAPPROVEDSET UPDocuments pendingPENDING_DOCUMENTSUnder reviewUNDER_REVIEWSetup pendingPENDING_SETUPConnectedACTIVEdocuments requiredno documentsyou: deliver to branchyou: waityou: enter bank detailsaccounts are listedLEGENDAPPLICATION STEPCONNECTED — ACCOUNTS ARE READSTART
The panel step and the API status are the same thing under two names. Banks that require no documents start at Setup pending.

For banks that require no documents, the application starts directly at the setup step. What each status means and what to do: Concepts › Connection statuses.

Connection details

On the Integrations screen, click Details on a bank's card. The details show the connection status, the application process, the application documents, the Details provided by your bank section, the application and activation dates, the time of the last successful read, the number of consecutive failed reads and the number of accounts. View accounts takes you to your accounts at this bank.

To see the balances and transactions of a connected bank, click the bank's card on the Bankalar (Banks) screen. → Banks and Statements › Bank details

Disconnect

In the connection details, click Disconnect and confirm.

  • The connection's status becomes DISCONNECTED and no new transactions are read from this bank.
  • The connection's accounts are not deleted; their status becomes INACTIVE.
  • To read the bank again you need to reconnect it; the new connection gets a new connectionId.
  • If you disconnect a connection in the application stage, the application ends; to reconnect you apply from the start.

Why you cannot connect a bank through the API

Connecting involves your bank details and application documents. These are entered only in the panel, with your panel session, and never pass through your server. A key cannot be granted permission to connect or disconnect; keys read data and, when permitted, send transfers and exchange currency.

The panel session and the API key are separate identities: requests used by the panel screens cannot be called with an API key, and API-key endpoints cannot be called with a panel session. → API Introduction