Connecting banks

Linking a bank means completing a provider flow (Plaid, Fiskil, SnapTrade, SaltEdge, and others), some of which are browser-mediated and need a real signed-in session. Rather than reimplement every provider handshake, the CLI hands off to the web app, which already implements them all, then waits for the result.

Connect a new bank#

banksync banks connect

Here is what happens:

1. The CLI snapshots the banks you already have.
2. It opens your browser to the app's connect flow, at a URL like https://app.banksync.io/{workspaceId}/banks?connect=1.
3. You complete the provider flow in the browser with your real session.
4. The CLI polls your workspace until the new bank appears, then prints it.

Opened your browser to connect a bank. Waiting for the new connection...⠹ waiting for a new bank✓ connected
ID         NAME        SOURCE   TYPE      STATUSbnk_x9y8   Wells Fargo plaid    personal  ● active

Polling runs for up to three minutes. If it times out, the connection may still have completed in the browser; run banksync banks list to check.

Pre-select a provider or institution#

Skip a step in the app by pre-seeding the flow:

banksync banks connect --provider plaidbanksync banks connect --institution ins_123

Headless and non-interactive#

Under --no-input (and automatically when there is no terminal), the CLI does not open a browser or poll. It prints the connect URL and exits, so you can open it on another device:

banksync banks connect --no-input

Open this URL to connect a bank:  https://app.banksync.io/ws_a1b2c3/banks?connect=1

Reauthenticate a bank#

When a connection needs re-consent (an expired or revoked provider session), send the user back into the app to fix it:

banksync banks reauth bnk_123

On a terminal this opens the browser to the reauth flow. When there is no browser, or under --no-input, it prints the URL to open manually. Reauth uses the same handoff pattern as connect.

Search the institution catalog#

Find connectable institutions before you connect, for example to grab an institution id to pre-seed:

banksync banks search chase

Narrow by country or provider:

banksync banks search "commonwealth" --country AUbanksync banks search chase --provider plaid:us -o json

• --country takes an ISO country code (for example US, AU).
• --provider takes a providerInstanceId (for example plaid:us).

ID          NAME                      COUNTRY   PROVIDERins_3       Chase                     US        plaid:usins_57      Chase (Business)          US        plaid:us
2 institutions

Inspect what you connected#

After connecting, list banks and drill into accounts:

banksync banks listbanksync banks get bnk_x9y8banksync accounts list bnk_x9y8

Next steps#

• Syncing and jobs: pull data from a connected bank.
• Output formats: tables, JSON, and column control.
• Authentication: API keys and profiles.