Sandbox

Test the Banklink API against synthetic data with a test key before going live.

Every endpoint has a sandbox on the same base URL. Use an sk_test_… key from the dashboard and call the API exactly as you would in production.

Sandbox requests:

are served from a synthetic dataset for your organisation
never reach a real bank
are never billed
for hosted requests, show your current branding, and their webhook and email deliveries are simulated, not sent

What you get

GET /accounts returns two seeded accounts with about 90 days of generated transactions.
POST /accounts/{id}/sync appends one to three new synthetic transactions.
POST /link links a new synthetic account. If any credential field equals "fail", the call returns a credential error instead. This lets you test your error handling.
POST /link-requests and POST /access-requests create synthetic hosted links. They work before your organisation is verified, and redirect_url may be http://localhost.

POST /sandbox/reset wipes your sandbox data and seeds it again. Use it between test runs to get a clean state.

Switch to an sk_live_… key and the production behaviour applies. Live hosted links need a verified link profile.