Skip to content

Banklink v2Customer-held keys and one-off fetches, through the Node.js SDK. v1 is unchanged.Migration guide

Banklink Docs

Banks

Which banks v2 can reach with the Node.js SDK, the login fields each needs, and the extra steps some add.

Call banklink.banks.list() for the banks v2 can reach right now. Each entry has the bankId, the login fields to collect (with a label and whether the field is secret), and needsOtpEveryLogin.

for (const bank of await banklink.banks.list()) {
console.log(bank.bankId, bank.fields.map((f) => f.name));
}

Build your login form from fields rather than hard-coding them, so a change at the bank doesn’t break your form.

Bank bankId SDK version Extra step
FNB fnb 0.3.0 and later None
Standard Bank standard_bank 0.3.0 and later Approval in the Standard Bank app, sometimes
Capitec capitec 0.4.0 and later A QR code to scan in the Capitec app at every sign-in. Online Banking must be on

Nedbank, ABSA and Discovery Bank aren’t in v2 yet. See the v1 bank connectors for those.

FNB ends a session when the same profile signs in somewhere else. If the account holder signs in on another device while the job runs, the job fails. Ask them to sign out of online banking elsewhere and try again.

Standard Bank may ask the account holder to approve each sign-in in the Standard Bank app. You get an awaiting_approval progress event with a deadline. If nobody approves in time, the job fails with ApprovalNotGivenError.

Approval can be needed on later syncs too, so a scheduled sync can fail when nobody is there to approve it.

Capitec needs only username and asks the account holder to scan a QR code in the Capitec app at every sign-in, including scheduled syncs. Show the code from the awaiting_qr_scan progress event. If it lapses, you get qr_expired with a short window to ask for a new one. v2 allows two codes per job. If nobody scans in time, the job fails with ApprovalNotGivenError.

Online Banking must be switched on for the Capitec profile. If it’s off, the job fails with OnlineBankingDisabledError. See Capitec for the steps to give the account holder.