Skip to content

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

Banklink Docs

Capitec

Link Capitec accounts with the account number or username. The account holder scans a QR code in the Capitec app at every sign-in.

bankId capitec
Status Live
Sign-in fields username (account number or Online Banking username)
Extra step A QR code the account holder scans in the Capitec app, at every sign-in

Capitec Online Banking has no password step. After the username, Capitec shows a QR code. The account holder opens the Capitec app, taps the menu (3 dots) at the top right of the sign-in screen, and scans it. Each code lasts 60 seconds.

The hosted link page and the dashboard show the code and its countdown for you. If you call the API yourself, ask for the progress stream and show the code to the account holder.

Send Accept: application/x-ndjson to POST /link or POST /accounts/{id}/sync. The reply is one JSON object per line. Show the image from awaiting_qr_scan, and use the last line, result, as the usual response.

Terminal window
curl -N https://api.banklink.co.za/v1/link \
-H "Authorization: Bearer $BANKLINK_API_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/x-ndjson" \
-d '{ "bankId": "capitec", "credentials": { "username": "THEIR_ACCOUNT_NUMBER" } }'
{"type":"progress","stage":"connecting"}
{"type":"progress","stage":"awaiting_qr_scan","qr":{"image":"data:image/jpeg;base64,/9j/4AAQ…","expiresAt":"2026-11-13T10:01:00.000Z","attempt":1}}
{"type":"heartbeat"}
{"type":"progress","stage":"fetching"}
{"type":"result","data":{"data":{"type":"success","profile_id":"…","account_number":"…"}}}

qr.image is a data: URL you can put straight into an <img>. Allow up to 310 seconds for the operation, and keep consuming heartbeats while the account holder scans.

If the code lapses unscanned, the stream sends qr_expired:

{"type":"progress","stage":"qr_expired","retryUntil":"2026-11-13T10:01:18.000Z","retryId":"3f2b8c1e-9d4a-4e6b-8f0a-1c2d3e4f5a6b"}

The account holder has until retryUntil (15 seconds) to ask for a new code, without entering anything again. Send the retryId to POST /bank-progress/qr-retry. It needs no API key: the retryId works once, only for this sign-in, and only inside the window. A new awaiting_qr_scan follows. A sign-in offers three codes at most. If none is scanned, the result is approval_not_given, and nothing is stored or charged.

The v2 worker uses the same browser journey. Polling GET /v2/jobs/{id} reports progress.stage: "awaiting_qr_scan" with qrImage (a data: image URL), qrExpiresAt and qrAttempt. An expired code reports stage: "qr_expired" with retryUntil. Send POST /v2/jobs/{id}/qr-retry with an empty JSON object and the job’s API key within that window. v2 permits two codes per job to fit its execution deadline. Link operations read accounts only; transaction operations read the requested accounts and date range.

Every Capitec sign-in needs someone to scan a code, so Capitec can’t run without the account holder present. Pulses, scheduled syncs and calls without the progress stream are refused with qr_handoff_required, before Banklink contacts Capitec. Nothing is charged.

  • Accounts. Every account on the profile, with its number, name and type. The v2 result also includes the current and available balances read from the portfolio. v1 balance responses use the latest stored transaction balance.
  • Transactions. Up to two years back. Capitec serves at most 6 months per request, so a longer range takes a few seconds more. Transactions Capitec still lists as unprocessed are left out until they clear.
  • Access Facility. Listed as an account; v2 includes its portfolio balance. Capitec offers no transaction list for it, so it has none.
Code Meaning
approval_not_given No code was scanned in time, or the sign-in was declined in the app.
online_banking_disabled Online Banking is switched off for this profile. The account holder can switch it on in the Capitec app.
customer_action_required Capitec wants the account holder to accept a notice or new terms in Online Banking first.
qr_handoff_required The call didn’t ask for the progress stream, or ran unattended.

Capitec accounts can’t be used as the billing account for credit top-ups yet. Use an FNB account for that.

See the Capitec launch notes for what changed when it went live.