{ "item": [ { "name": "Meta", "description": "", "item": [ { "id": "83f22b82-24c2-4891-9ffc-3d1f2b99cbf8", "name": "Health check", "request": { "name": "Health check", "description": { "content": "Returns the API status and version. Does not bill a credit.", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a3584953-5d1d-406a-b487-ade2d87d6ac9", "name": "API is healthy", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"status\": \"\",\n \"version\": \"\",\n \"mode\": \"test\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b394e5c2-0a57-4efc-b412-3c0efc14ab8d", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f3dc732-b64b-45af-8af1-348990d0ca63", "name": "Validate API key", "request": { "name": "Validate API key", "description": { "content": "Returns information about the authenticated API key. Does not bill a credit.", "type": "text/plain" }, "url": { "path": [ "auth", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ded5b0aa-f57d-4675-a6f0-76e8033b29b4", "name": "API key details", "originalRequest": { "url": { "path": [ "auth", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"valid\": \"\",\n \"key_id\": \"\",\n \"org_id\": \"\",\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b937ab48-1af4-46e9-b15b-71055ca0e96b", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "auth", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "636f7082-1ca0-4737-a5e4-aab0dd0364b0", "name": "Reset sandbox data", "request": { "name": "Reset sandbox data", "description": { "content": "**Test mode only.** Wipes your organisation's sandbox accounts and\ntransactions; the next call re-seeds a fresh dataset. Returns `404` when\ncalled with a live (`sk_live_`) key.\n", "type": "text/plain" }, "url": { "path": [ "sandbox", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "84d6e911-f311-4919-9744-b00280874f4c", "name": "Sandbox reset", "originalRequest": { "url": { "path": [ "sandbox", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"reset\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d749741-eb47-46cb-a299-e7ad89292891", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "sandbox", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Requests", "description": "", "item": [ { "id": "2085b260-7855-4c9b-b93d-326ff1734376", "name": "Create a persistent link request", "request": { "name": "Create a persistent link request", "description": { "content": "Creates a single-use hosted URL to send to your customer. Completing the\nlink creates a reusable bank profile and stores encrypted credentials for\nlater syncs. Set `save_data: true` to retain the fetched transactions in\nBanklink in addition to any webhook or email delivery.\n\nRequires the `link` scope. Test keys create a synthetic hosted link and\ndo not contact a bank or external destination.\n", "type": "text/plain" }, "url": { "path": [ "link-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"\",\n \"destinations\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"name\": \"\",\n \"bank_id\": \"standard_bank\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b11d9fc2-e1e5-45a4-a4d8-9f4a0b7875a1", "name": "Link request created", "originalRequest": { "url": { "path": [ "link-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"\",\n \"destinations\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"name\": \"\",\n \"bank_id\": \"standard_bank\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"reference\": \"\",\n \"token\": \"\",\n \"url\": \"\",\n \"status\": \"pending\",\n \"created_at\": \"\",\n \"bank_id\": \"\",\n \"return_options\": {},\n \"save_data\": \"\",\n \"expires_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db23b11f-1283-4e79-98bf-a84663251d78", "name": "Invalid request configuration", "originalRequest": { "url": { "path": [ "link-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"\",\n \"destinations\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"name\": \"\",\n \"bank_id\": \"standard_bank\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe495d28-b6c1-4e40-a51a-b5882266d01e", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "link-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"\",\n \"destinations\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"name\": \"\",\n \"bank_id\": \"standard_bank\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4aa50525-861e-4e9e-adf9-dca631ff1eff", "name": "Create a non-persistent access request", "request": { "name": "Create a non-persistent access request", "description": { "content": "Creates a single-use hosted URL to send to your customer. Banklink logs\nin, fetches the configured date range, and sends it to the configured\nwebhook or email. It does not create a bank profile and never stores the\ncustomer's credentials or fetched transactions. Dashboard destinations\nand `save_data` are therefore not supported.\n\nRequires the `link` scope. Test keys create a synthetic hosted link and\ndo not contact a bank or external destination.\n", "type": "text/plain" }, "url": { "path": [ "access-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"\",\n \"destinations\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"name\": \"\",\n \"bank_id\": \"standard_bank\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5d4344c5-771e-472a-adff-9271be9a0f49", "name": "Access request created", "originalRequest": { "url": { "path": [ "access-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"\",\n \"destinations\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"name\": \"\",\n \"bank_id\": \"standard_bank\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"reference\": \"\",\n \"token\": \"\",\n \"url\": \"\",\n \"status\": \"pending\",\n \"created_at\": \"\",\n \"bank_id\": \"\",\n \"return_options\": {},\n \"save_data\": \"\",\n \"expires_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bb281f0-fc4c-4482-8df7-e933e8624557", "name": "Invalid request configuration", "originalRequest": { "url": { "path": [ "access-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"\",\n \"destinations\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"name\": \"\",\n \"bank_id\": \"standard_bank\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46248ee3-2900-47b0-909a-fc0779ce5bb0", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "access-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reference\": \"\",\n \"destinations\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"name\": \"\",\n \"bank_id\": \"standard_bank\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Accounts", "description": "", "item": [ { "id": "f57b3b8f-08b0-4371-8f4f-8d3baac2f00d", "name": "List bank accounts", "request": { "name": "List bank accounts", "description": { "content": "Returns all linked bank accounts for the authenticated organisation.", "type": "text/plain" }, "url": { "path": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7af5939f-b73c-40c0-bb92-c9cef2695b54", "name": "List of accounts", "originalRequest": { "url": { "path": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"bank\": \"\",\n \"account_number\": \"\",\n \"nickname\": \"\",\n \"last_synced_at\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"bank\": \"\",\n \"account_number\": \"\",\n \"nickname\": \"\",\n \"last_synced_at\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fae39462-4a6f-4dd2-839f-5a3c4086c19d", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd563552-91a2-4467-865b-99076d64212a", "name": "Get bank account", "request": { "name": "Get bank account", "description": { "content": "Returns a single linked bank account by ID.", "type": "text/plain" }, "url": { "path": [ "accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "42d3d61f-345b-4ef2-ad6b-fdc25dc9a803", "name": "Account details", "originalRequest": { "url": { "path": [ "accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"bank\": \"\",\n \"account_number\": \"\",\n \"nickname\": \"\",\n \"last_synced_at\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e10291-e224-47c6-8f98-e479c7ad4e41", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fd82ca6-7057-4a58-bc67-2dd180f44240", "name": "Resource not found", "originalRequest": { "url": { "path": [ "accounts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c25d60a7-6d01-4604-b420-83c0086ad987", "name": "List transactions", "request": { "name": "List transactions", "description": { "content": "Returns cursor-paginated transactions for the specified account, ordered\nby date descending. Maximum 500 per page (default 100).\n", "type": "text/plain" }, "url": { "path": [ "accounts", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of transactions to return (1–500, default 100)", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned by a previous response", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6106f0b1-f94c-4b83-99a6-65e7ab2ab7a6", "name": "Paginated transaction list", "originalRequest": { "url": { "path": [ "accounts", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of transactions to return (1–500, default 100)", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned by a previous response", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"external_id\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"direction\": \"credit\",\n \"balance\": \"\",\n \"reference\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"external_id\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"direction\": \"debit\",\n \"balance\": \"\",\n \"reference\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef6d9b5d-eca4-4f20-8583-489ffcebcc5a", "name": "Invalid cursor", "originalRequest": { "url": { "path": [ "accounts", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of transactions to return (1–500, default 100)", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned by a previous response", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee7652da-974b-41b6-ba26-047af0f5a9fd", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "accounts", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of transactions to return (1–500, default 100)", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned by a previous response", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db02fdab-39b1-4681-8300-ee0e7c132c53", "name": "Resource not found", "originalRequest": { "url": { "path": [ "accounts", ":id", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of transactions to return (1–500, default 100)", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned by a previous response", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2b17d57-cd3a-41ae-b4be-3601b57a6ced", "name": "Get account balance", "request": { "name": "Get account balance", "description": { "content": "Returns the latest known balance for the account, derived from the most\nrecent stored transaction. Returns `null` balance if no transactions have\nbeen ingested yet.\n", "type": "text/plain" }, "url": { "path": [ "accounts", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e9434895-02c5-421e-a49b-bdd16a4dd73c", "name": "Latest balance", "originalRequest": { "url": { "path": [ "accounts", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"account_id\": \"\",\n \"balance\": \"\",\n \"currency\": \"\",\n \"last_synced_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3782788f-a446-4bd7-9110-250d52f927b8", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "accounts", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49958935-031e-44ed-929a-7a7e16b32af5", "name": "Resource not found", "originalRequest": { "url": { "path": [ "accounts", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "485f802a-d37d-4abb-98d4-d699f0ac9ddc", "name": "Trigger sync", "request": { "name": "Trigger sync", "description": { "content": "Triggers an immediate bank sync for the specified account. Rate-limited\nto prevent abuse. Returns the number of new transactions ingested and\nthe number of duplicates skipped.\n", "type": "text/plain" }, "url": { "path": [ "accounts", ":id", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "7702924a-1ca5-42bc-a0b5-775f116daec4", "name": "Sync result", "originalRequest": { "url": { "path": [ "accounts", ":id", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"synced\": \"\",\n \"skipped\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31438a50-ff1e-4090-9209-97566b03c6dd", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "accounts", ":id", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2bcfe05-0d2e-49af-ab9d-8ef4602c06ec", "name": "Resource not found", "originalRequest": { "url": { "path": [ "accounts", ":id", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42c5383c-68a2-41ad-893a-71911b92f616", "name": "Too many requests — try again later", "originalRequest": { "url": { "path": [ "accounts", ":id", "sync" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) UUID of the bank account (bank profile)", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Usage", "description": "", "item": [ { "id": "889ac33b-f478-4840-ae9f-9f4bda8d6dd5", "name": "Report external usage", "request": { "name": "Report external usage", "description": { "content": "Records an external API call for reporting and analytics. Intended for\nuse by external services acting on the organisation's behalf. This\nendpoint is not billed.\n", "type": "text/plain" }, "url": { "path": [ "usage", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"\",\n \"method\": \"\",\n \"response_code\": \"\",\n \"invocation_type\": \"\",\n \"invocation_source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f0ad95aa-c8c9-40e8-9da6-89112a267bb7", "name": "Usage recorded", "originalRequest": { "url": { "path": [ "usage", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"\",\n \"method\": \"\",\n \"response_code\": \"\",\n \"invocation_type\": \"\",\n \"invocation_source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"success\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23708800-bef3-42ef-b276-2b77fd1e73b1", "name": "Missing required fields", "originalRequest": { "url": { "path": [ "usage", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"\",\n \"method\": \"\",\n \"response_code\": \"\",\n \"invocation_type\": \"\",\n \"invocation_source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf8aebaa-9ca4-4e9f-9b7d-29c7a43e5e00", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "usage", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"\",\n \"method\": \"\",\n \"response_code\": \"\",\n \"invocation_type\": \"\",\n \"invocation_source\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Linking", "description": "", "item": [ { "id": "0b6f6ca8-645a-4b93-8964-00a686fb310d", "name": "Link bank account", "request": { "name": "Link bank account", "description": { "content": "Links a bank account by verifying the provided credentials against the\nbank portal. On success, creates a `bank_profile` entry and returns the\nprofile ID and account number. The link completes in a single call.\n\nSupported bank IDs: `fnb`, `absa`, `nedbank`, `standard_bank`, `discovery`.\n", "type": "text/plain" }, "url": { "path": [ "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankId\": \"fnb\",\n \"credentials\": {\n \"key_0\": \"\"\n },\n \"nickname\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "69704716-1814-4956-ba9e-7066835a1dcc", "name": "Link result. The `type` field distinguishes between outcomes:\n- `success` — account linked successfully\n- `error` — credential verification failed", "originalRequest": { "url": { "path": [ "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankId\": \"fnb\",\n \"credentials\": {\n \"key_0\": \"\"\n },\n \"nickname\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"type\": \"success\",\n \"profile_id\": \"\",\n \"account_number\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e3a901e-4a60-4908-b3d0-f7d1d0eb8a90", "name": "Missing or invalid request fields", "originalRequest": { "url": { "path": [ "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankId\": \"fnb\",\n \"credentials\": {\n \"key_0\": \"\"\n },\n \"nickname\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65fa0487-4d5e-4344-88cc-eb342831a79d", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankId\": \"fnb\",\n \"credentials\": {\n \"key_0\": \"\"\n },\n \"nickname\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.banklink.co.za/v1" } ], "info": { "_postman_id": "80b70eba-d110-413f-810d-653d402a608f", "name": "Banklink API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Banklink v1 API lets you list linked bank accounts, retrieve transactions,\ncheck balances, trigger syncs, and create hosted link or access requests.\n\nA **link request** creates a reusable bank profile and stores encrypted bank\ncredentials. Set `save_data` to control whether its first fetch is also saved\nin Banklink. An **access request** performs one configured fetch and delivery;\nBanklink never stores that customer's credentials or transactions.\n\nAll endpoints require a Bearer API key in the `Authorization` header.\nSuccessful responses are wrapped in a `{ \"data\": ... }` envelope. Errors use\n`{ \"error\": { \"code\", \"message\" } }`. List endpoints additionally include a\n`\"cursor\"` field for pagination.\n\n## Sandbox (test mode)\n\nEvery endpoint has a sandbox on the **same base URL**. Create a **test key**\n(`sk_test_...`) in the dashboard and use it exactly like a live key — requests\nare served from a synthetic per-organisation dataset, never touch a real bank,\nand are never billed.\n\n- `GET /accounts` returns two seeded accounts with ~90 days of generated\n transactions.\n- `POST /accounts/{id}/sync` appends 1–3 new synthetic transactions.\n- `POST /link-requests` and `POST /access-requests` create synthetic hosted\n links. Their webhook/email deliveries are simulated and never sent.\n- `POST /link` — any credential field equal to `\"fail\"` returns a credential\n error; anything else links a new synthetic account.\n- `POST /sandbox/reset` wipes and re-seeds your sandbox.\n", "type": "text/plain" } } }