{ "item": [ { "name": "Meta", "description": "", "item": [ { "id": "6745246b-0858-450d-b301-265baf230ef5", "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": "377267e8-b102-4b2b-b936-908c793f77d5", "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": "bb50596f-509c-4d3a-8f19-8ee3ad36e397", "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": "0a8bbad2-8337-4dda-8830-7ab3961a81c7", "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": "88d56374-30e5-4c89-971e-e68e3da7bf30", "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": "30eff6b8-5ef3-40fb-aeaa-1befa98f20bc", "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": "5ed8750f-78da-4b0a-897a-e6a3676fa7db", "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": "de778120-a306-4ab8-b92e-8c9ddca98cac", "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": "5e12a9fd-5199-46cf-893b-8c5b813695f0", "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": "c6f73250-7845-46b6-aece-9875e2c97920", "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 and a verified link profile. Test keys create\na synthetic hosted link and do 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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ffa90e0f-b7ad-4786-9fbb-4a4a6f556dc2", "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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\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\": \"revoked\",\n \"created_at\": \"\",\n \"bank_id\": \"\",\n \"return_options\": {},\n \"kind\": \"access\",\n \"name\": \"\",\n \"save_data\": \"\",\n \"redirect_url\": \"\",\n \"expires_at\": \"\",\n \"completed_at\": \"\",\n \"last_error\": \"\",\n \"delivery_error\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82fefb4b-acaa-4388-97e6-fe18a49df3a4", "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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\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": "0d6a5bef-f8c5-4210-b6b3-a2a8265a7793", "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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\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" }, { "id": "cdfc8d1d-3623-4733-b092-b6d3b41f50f1", "name": "The organisation's link profile isn't verified yet", "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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "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": "bccedbca-53d7-4a7c-8100-8009679b91ba", "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 and a verified link profile. Test keys create\na synthetic hosted link and do 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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d596e4d7-7887-4d74-a3e9-428cb86a67f7", "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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\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\": \"revoked\",\n \"created_at\": \"\",\n \"bank_id\": \"\",\n \"return_options\": {},\n \"kind\": \"access\",\n \"name\": \"\",\n \"save_data\": \"\",\n \"redirect_url\": \"\",\n \"expires_at\": \"\",\n \"completed_at\": \"\",\n \"last_error\": \"\",\n \"delivery_error\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8031a101-a1d1-4b79-8eda-82800705432b", "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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\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": "e11bc6c6-3556-420f-8bbc-da932ce970f2", "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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\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" }, { "id": "7fddda8e-c59e-4ea6-8b31-d2dc59f89ce3", "name": "The organisation's link profile isn't verified yet", "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\": \"fnb\",\n \"return_options\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\"\n },\n \"save_data\": false,\n \"expires_at\": \"\",\n \"redirect_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "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": "c0a755b8-5025-44e4-98ec-918213976d8a", "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": "8ab11b03-80ad-4c37-9785-ad2ff090c6f8", "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": "b76f4545-d295-4b8e-b1c1-d8ff9e8c3885", "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": "80b9f8c2-7922-4891-9d36-4951e7bf408d", "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": "48472d44-3fad-4e6d-9d9a-22525e3df328", "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": "7a6f3eea-ee11-4ae5-ac16-e0d1dee27154", "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": "713456f8-f4a4-4303-b748-15616fbb469f", "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": "93771d9c-f750-40f8-b395-22e71b0b3668", "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": "24f5b84d-6b61-4322-ad9d-9001a7de18e0", "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\": \"debit\",\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\": \"credit\",\n \"balance\": \"\",\n \"reference\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d22cc16-7859-41d3-a22d-b5ccfdf7f939", "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": "8b97660a-b9f6-457b-b2a1-f9bc8acb10dc", "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": "0855ee9e-ff43-4bef-9002-2a40079b5039", "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": "a206d0ec-80cf-4bff-b753-c91104629967", "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": "b03def06-cf24-4b69-8641-1ef245726ee8", "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": "d304c4ca-a22d-4d92-b3ed-aa2e82591b15", "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": "f59fa278-e4b7-4bba-9f36-c35c9da6600b", "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": "f172c757-84e5-442b-9286-4670b36bb445", "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": "9ef42176-e69d-45f7-887d-97ed29b9c0ed", "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": "22ce3260-cc64-4745-94a0-8c96b889f213", "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": "b069661e-e1c5-4b28-83f3-8c0b3fc5142f", "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": "60b9f94f-c08d-4568-8f0e-14ba6c838e5b", "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": "27d26760-ac0e-4362-999b-307016211435", "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": "44ee7717-8b9d-4945-aa87-4f3a6aae8714", "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": "b32e7e5d-e270-422a-8567-64044ce1cbb7", "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": "957db402-c7a0-42aa-accd-f3293e7359d4", "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": "2e09288b-bd6e-482b-a0e4-116f2f60f05e", "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\": \"nedbank\",\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"nickname\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4fd0459a-c9e0-4d39-9c7a-120b3e9efcec", "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\": \"nedbank\",\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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": "b6a6fb63-e328-4a38-b7f5-3868b04fa5b5", "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\": \"nedbank\",\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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": "78b42fa6-3787-4200-9906-b4e4134cefaf", "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\": \"nedbank\",\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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": "b041401f-c76c-4911-9ef4-0bc5a0f4164b", "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\n## Verification\n\nLive link and access requests need a **verified link profile**: your name,\nlogo, website domain, privacy policy and privacy contact, shown to the\ncustomer on the hosted consent screen. Verify in the dashboard (Link\nRequests → Branding & verification) by proving you control the domain and\ndisclosing Banklink in your privacy policy, or by requesting a manual\nreview. Until then these endpoints return `403 org_not_verified`. Live\nwebhook and redirect URLs must be https on your verified domain. See\nhttps://banklink.co.za/resources/verify-organisation-link-requests.\n\n## Webhooks\n\nWebhook deliveries (link requests, access requests and Pulses) are signed.\nEach carries `Banklink-Signature: t=,v1=`, where `v1` is an\nHMAC-SHA256 of `{t}.{raw body}` keyed with your webhook signing secret\n(dashboard → Settings → Webhook signing). Verify against the raw body,\ncompare in constant time, and reject timestamps older than five minutes.\nDuring the 24 hours after a secret rotation the header carries two `v1`\nvalues; accept either. `Banklink-Delivery` is a unique id per delivery and\n`Banklink-Event` names the event. The SDKs ship `constructWebhookEvent` /\n`construct_event` helpers. See the `webhooks` section for payloads.\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. They work before your organisation is verified, show your current\n branding, and their webhook/email deliveries are simulated and never sent.\n `redirect_url` may also be `http://localhost`.\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" } } }