Skip to content

Reduced pricingA fetch now costs R4 (VAT included) on pay per use.Read the changelog

Banklink Docs

Bank connectors

Which South African banks Banklink connects to, what each needs to sign in, and the extra steps some of them add.

A bank connector signs in to a bank’s online banking with the account holder’s login, then reads their accounts, transactions and balances. Each bank asks for different sign-in details, and some add a step: an approval in the bank’s app, or a QR code the account holder scans.

Bank bankId Status Sign-in fields Extra step
FNB fnb Live username, password None
Standard Bank standard_bank Live identifier, password Approval in the Standard Bank app, sometimes
Nedbank nedbank Live identifier, password None, unless Nedbank asks for an approval or one-time PIN
Capitec capitec Live username A QR code scanned in the Capitec app, at every sign-in
ABSA absa Coming soon identifier, pin, password None
Discovery Bank discovery Coming soon identifier, password None

Pass the bankId and the sign-in fields to POST /link, or let the customer enter them on a hosted link page. Live keys return 400 Unsupported bank for a bank that isn’t live yet. Test keys accept every bankId, so you can build against a coming-soon bank in the sandbox now.

Some banks add a second step after the password. The hosted link page asks the customer for it. If you call POST /link yourself, handle it as below.

  • QR code (Capitec). Every sign-in shows a QR code the account holder scans in the Capitec app. Ask for the progress stream (Accept: application/x-ndjson) and show the code from the awaiting_qr_scan event. See Capitec for the events and how to ask for a new code. Without the stream, or on a Pulse, Capitec is refused with qr_handoff_required.

  • App approval (Standard Bank). The bank may ask the account holder to approve the sign-in in its app. POST /link waits for the approval, so allow up to two minutes. If nobody approves it, the link fails, and nothing is stored or charged.

  • Approval or one-time PIN (Nedbank). Nedbank sometimes asks for an approval in the Nedbank Money app or a one-time PIN. Banklink can’t complete either step for Nedbank yet, so the link fails. Nothing is stored or charged.

These steps can come back on later syncs. A Pulse that runs while nobody is there to approve a sign-in fails for that run.

POST /link returns a type: "error" result. POST /accounts/{id}/sync returns 422 with a code and a message you can show the customer. Neither is charged.

Code Meaning
invalid_credentials The bank did not accept the login details.
account_locked The online banking profile is blocked.
concurrent_session The profile is signed in somewhere else, and the bank ended this session.
no_accounts_linked The profile has no bank accounts.
approval_not_given The sign-in was not approved or scanned in the bank’s app in time.
online_banking_disabled Online banking is switched off for the profile in the bank’s app.
customer_action_required The bank wants the account holder to accept a notice or new terms in online banking first.
qr_handoff_required The bank needs a QR scan at every sign-in, and nobody was there to scan it (Capitec).

One login can hold several bank accounts, such as a cheque account and a savings account. Banklink reads all of them. They are listed in each account’s bank_accounts, and transactions, balances and sync results carry the account_number they belong to.