Start here
Create a test API key and make your first Banklink API requests.
Quick start
Section titled “Quick start”1. Create a test key
Section titled “1. Create a test key”Sign in to the dashboard and create a test API key (sk_test_…). Test keys use synthetic sandbox data and are never billed.
Set the key in your terminal so you can use it in the requests below:
export BANKLINK_API_KEY='YOUR_TEST_API_KEY'Keep API keys on your server. Never include them in browser code or commit them to source control.
2. Validate your key
Section titled “2. Validate your key”curl https://api.banklink.co.za/v1/auth/validate \ -H "Authorization: Bearer $BANKLINK_API_KEY"3. List sandbox accounts
Section titled “3. List sandbox accounts”curl https://api.banklink.co.za/v1/accounts \ -H "Authorization: Bearer $BANKLINK_API_KEY"The response contains synthetic accounts under data. You can use them to test transactions and balances without connecting a real bank account.
Before going live
Section titled “Before going live”Read Authentication for key handling and Webhooks for event delivery. Before creating live hosted links, verify your organisation’s link profile, then switch to a live key (sk_live_…).
What you can build
Section titled “What you can build”- Persistent links. A link request stores the customer’s bank login, encrypted, so you can fetch from that account later.
- One-off access. An access request performs one fetch and delivers it. Banklink stores neither the credentials nor the transactions.
- Reads. List accounts, transactions and balances, and trigger a sync.
- Webhooks. Receive signed events when a link completes, an access request completes, or a Pulse delivers transactions.
Conventions
Section titled “Conventions”| Base URL | https://api.banklink.co.za/v1 |
| Auth | Authorization: Bearer <API key> on every request |
| Success | { "data": … } |
| Errors | { "error": { "code", "message" } } |
| Lists | Include a cursor field for the next page |