{ "info": { "_postman_id": "95407fea-fc20-45eb-b199-39af6a781e1c", "name": "Moneyhub Data API", "description": "Documentation for the Moneyhub data API.
Authentication is via bearer token.
", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:14:56.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "lastUpdatedBy": "35240", "uid": "35240-95407fea-fc20-45eb-b199-39af6a781e1c" }, "item": [ { "name": "accounts", "item": [ { "name": "{accountId}", "item": [ { "name": "balances", "item": [ { "name": "Retrieve the historical balances for an account", "id": "9701d8f9-fff0-48d4-9974-ab22cb61d6d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "id": "c0f596a6-ac5a-48c1-89f8-e7c34b175311", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** scope." }, "response": [ { "id": "f37dec4f-f64e-46b9-a29b-32ebfcf42f81", "name": "Successful Balances Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ClosingAvailable\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ClosingBooked\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f37dec4f-f64e-46b9-a29b-32ebfcf42f81" }, { "id": "2322f258-0d30-4133-9d36-f36d286badef", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2322f258-0d30-4133-9d36-f36d286badef" }, { "id": "ca2b265a-e1ab-47d7-830d-f698b61a2f8a", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ca2b265a-e1ab-47d7-830d-f698b61a2f8a" }, { "id": "ee05848c-712e-49e8-acdd-72ee8ea89cc0", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ee05848c-712e-49e8-acdd-72ee8ea89cc0" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9701d8f9-fff0-48d4-9974-ab22cb61d6d5" }, { "name": "Add a new balance for an account", "id": "de55965e-b4ce-4105-881a-1f7f5cb5eba3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "id": "2fcb10b3-df4c-4512-93c4-24b021f618db", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** and either of **accounts:write** or **accounts:write:all** scopes." }, "response": [ { "id": "b5bfade1-26c1-4d0e-bad9-04d44e8f9668", "name": "Successful Balance Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ForwardAvailable\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b5bfade1-26c1-4d0e-bad9-04d44e8f9668" }, { "id": "a521e711-2f1a-45d9-aaa8-72891c3c5d02", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a521e711-2f1a-45d9-aaa8-72891c3c5d02" }, { "id": "b0df821f-d20e-4e42-9862-d18736bb493c", "name": "Unsuccessful Balance Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b0df821f-d20e-4e42-9862-d18736bb493c" }, { "id": "131dad9b-9108-4aaf-a696-18336ce35ea9", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/balances", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balances" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-131dad9b-9108-4aaf-a696-18336ce35ea9" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-de55965e-b4ce-4105-881a-1f7f5cb5eba3" } ], "id": "38a86687-693e-4e2f-9f6b-96b95880cae5", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-38a86687-693e-4e2f-9f6b-96b95880cae5" }, { "name": "holdings", "item": [ { "name": "{holdingId}", "item": [ { "name": "Retrieves a single holding for an account with matched ISIN codes", "id": "ef0eba69-ad7c-448f-b2ea-9bc507668705", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings/:holdingId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings", ":holdingId" ], "variable": [ { "id": "1f66c7ab-0b35-4787-bb73-e9668b2f9299", "key": "accountId", "value": "", "description": "(Required) The Account Id" }, { "id": "39803206-f2ba-4eab-91fe-2cbf8423cfac", "key": "holdingId", "value": "", "description": "(Required) The Holding Id" } ] }, "description": "Requires **accounts:read** scope." }, "response": [ { "id": "a1cec0ff-eb76-44c6-9c55-6f22ccc4d323", "name": "Successful Holding Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings/:holdingId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings", ":holdingId" ], "variable": [ { "key": "accountId" }, { "key": "holdingId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"name\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"codes\": [\n {\n \"code\": \"\",\n \"type\": \"MEX\"\n },\n {\n \"code\": \"\",\n \"type\": \"SEDOL\"\n }\n ],\n \"history\": [\n {\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"costBasis\": \"\",\n \"quantity\": \"\",\n \"date\": \"\"\n },\n {\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"costBasis\": \"\",\n \"quantity\": \"\",\n \"date\": \"\"\n }\n ],\n \"matched\": [\n {\n \"isin\": \"\",\n \"name\": \"\",\n \"score\": \"\",\n \"priceGBP\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"date\": \"\"\n },\n {\n \"isin\": \"\",\n \"name\": \"\",\n \"score\": \"\",\n \"priceGBP\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"date\": \"\"\n }\n ],\n \"id\": \"\",\n \"date\": \"\",\n \"costBasis\": \"\",\n \"currency\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a1cec0ff-eb76-44c6-9c55-6f22ccc4d323" }, { "id": "fd2b6ea2-fd32-4f64-a475-9af6783b993a", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings/:holdingId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings", ":holdingId" ], "variable": [ { "key": "accountId" }, { "key": "holdingId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fd2b6ea2-fd32-4f64-a475-9af6783b993a" }, { "id": "13b61a27-5122-4d04-bf69-271bc392ae00", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings/:holdingId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings", ":holdingId" ], "variable": [ { "key": "accountId" }, { "key": "holdingId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-13b61a27-5122-4d04-bf69-271bc392ae00" }, { "id": "4482206e-64a7-41b2-b4b2-74b5c600783f", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings/:holdingId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings", ":holdingId" ], "variable": [ { "key": "accountId" }, { "key": "holdingId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4482206e-64a7-41b2-b4b2-74b5c600783f" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ef0eba69-ad7c-448f-b2ea-9bc507668705" } ], "id": "576ff9e5-e4ae-4c83-8dee-311a511e3424", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-576ff9e5-e4ae-4c83-8dee-311a511e3424" }, { "name": "Retrieve the holdings for an account", "id": "28d69a9b-c0e2-4d8c-a7b8-4429b705b699", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings" ], "variable": [ { "id": "f04af893-42a2-4fad-8cb0-650ea525168e", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** scope." }, "response": [ { "id": "bf5cdd1d-f811-406f-bc21-fb54c7aef615", "name": "Successful Holdings Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"date\": \"\",\n \"items\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"codes\": [\n {\n \"code\": \"\",\n \"type\": \"SEDOL\"\n },\n {\n \"code\": \"\",\n \"type\": \"ISIN\"\n }\n ],\n \"id\": \"\",\n \"costBasis\": \"\",\n \"currency\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"codes\": [\n {\n \"code\": \"\",\n \"type\": \"MEX\"\n },\n {\n \"code\": \"\",\n \"type\": \"MEX\"\n }\n ],\n \"id\": \"\",\n \"costBasis\": \"\",\n \"currency\": \"\"\n }\n ]\n },\n {\n \"date\": \"\",\n \"items\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"codes\": [\n {\n \"code\": \"\",\n \"type\": \"SEDOL\"\n },\n {\n \"code\": \"\",\n \"type\": \"SEDOL\"\n }\n ],\n \"id\": \"\",\n \"costBasis\": \"\",\n \"currency\": \"\"\n },\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"codes\": [\n {\n \"code\": \"\",\n \"type\": \"MEX\"\n },\n {\n \"code\": \"\",\n \"type\": \"ISIN\"\n }\n ],\n \"id\": \"\",\n \"costBasis\": \"\",\n \"currency\": \"\"\n }\n ]\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bf5cdd1d-f811-406f-bc21-fb54c7aef615" }, { "id": "966b1127-b114-40fb-8f65-ce9d61754c96", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-966b1127-b114-40fb-8f65-ce9d61754c96" }, { "id": "469f5784-fb7b-449c-8428-b431655e63e9", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-469f5784-fb7b-449c-8428-b431655e63e9" }, { "id": "24bb0f6e-0995-4984-b2f2-822b50dd8cf3", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-24bb0f6e-0995-4984-b2f2-822b50dd8cf3" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-28d69a9b-c0e2-4d8c-a7b8-4429b705b699" } ], "id": "6d32f812-020e-4687-a221-b08c832eb84d", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6d32f812-020e-4687-a221-b08c832eb84d" }, { "name": "holdings-with-matches", "item": [ { "name": "Retrieve the holdings for an account with matched ISIN codes", "id": "00da10f8-aa4a-401e-bccc-87e9a5511d8e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings-with-matches", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings-with-matches" ], "variable": [ { "id": "a470f693-9906-4684-96b4-affac4dbbeae", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** scope." }, "response": [ { "id": "c16b16e1-5426-48dd-a5b2-1045ac49b3f5", "name": "Successful Holdings Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings-with-matches", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings-with-matches" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"codes\": [\n {\n \"code\": \"\",\n \"type\": \"ISIN\"\n },\n {\n \"code\": \"\",\n \"type\": \"ISIN\"\n }\n ],\n \"id\": \"\",\n \"matched\": [\n {\n \"isin\": \"\",\n \"name\": \"\",\n \"score\": \"\",\n \"priceGBP\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"date\": \"\"\n },\n {\n \"isin\": \"\",\n \"name\": \"\",\n \"score\": \"\",\n \"priceGBP\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"date\": \"\"\n }\n ],\n \"date\": \"\",\n \"costBasis\": \"\",\n \"currency\": \"\"\n },\n {\n \"name\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"codes\": [\n {\n \"code\": \"\",\n \"type\": \"MEX\"\n },\n {\n \"code\": \"\",\n \"type\": \"SEDOL\"\n }\n ],\n \"id\": \"\",\n \"matched\": [\n {\n \"isin\": \"\",\n \"name\": \"\",\n \"score\": \"\",\n \"priceGBP\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"date\": \"\"\n },\n {\n \"isin\": \"\",\n \"name\": \"\",\n \"score\": \"\",\n \"priceGBP\": \"\",\n \"price\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"date\": \"\"\n }\n ],\n \"date\": \"\",\n \"costBasis\": \"\",\n \"currency\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c16b16e1-5426-48dd-a5b2-1045ac49b3f5" }, { "id": "4c7cdcf9-154b-4be8-9b7c-e65d43c93288", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings-with-matches", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings-with-matches" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4c7cdcf9-154b-4be8-9b7c-e65d43c93288" }, { "id": "fc5b8bc6-668c-4ef0-9d32-8891de4191d7", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings-with-matches", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings-with-matches" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fc5b8bc6-668c-4ef0-9d32-8891de4191d7" }, { "id": "259ceef6-346a-45f0-bc73-860b4ca302c6", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/holdings-with-matches", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "holdings-with-matches" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-259ceef6-346a-45f0-bc73-860b4ca302c6" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-00da10f8-aa4a-401e-bccc-87e9a5511d8e" } ], "id": "6be5afcb-acb3-4d17-9d58-713714b3cd8b", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6be5afcb-acb3-4d17-9d58-713714b3cd8b" }, { "name": "counterparties", "item": [ { "name": "Retrieve the counterparties for an account", "id": "5cf5d09d-6e25-4c71-9099-ed59d258c74b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/counterparties?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "counterparties" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "id": "1821492d-e5f3-4225-9f4e-01b8c2f17f99", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "**THIS ENDPOINT IS DEPRECATED.** Requires **accounts:read** and **transactions:read:all** scope." }, "response": [ { "id": "4bb6c19e-0006-49d1-8d70-4462a7b9dd78", "name": "Successful Counterparties Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/counterparties?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "counterparties" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"local\",\n \"companyName\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"mcc\": {\n \"code\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"type\": \"local\",\n \"companyName\": \"\",\n \"logo\": \"\",\n \"website\": \"\",\n \"mcc\": {\n \"code\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4bb6c19e-0006-49d1-8d70-4462a7b9dd78" }, { "id": "bcf0dbc8-b63a-4037-9183-4f0741c65ad6", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/counterparties?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "counterparties" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bcf0dbc8-b63a-4037-9183-4f0741c65ad6" }, { "id": "d0b63baf-623c-4e69-8354-16e6e7a04bb2", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/counterparties?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "counterparties" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d0b63baf-623c-4e69-8354-16e6e7a04bb2" }, { "id": "24bf2502-4322-4dfd-8d37-44ca5a0c64a6", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/counterparties?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "counterparties" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-24bf2502-4322-4dfd-8d37-44ca5a0c64a6" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5cf5d09d-6e25-4c71-9099-ed59d258c74b" } ], "id": "3dc02108-e268-4a8f-b42f-afb0cd78548c", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3dc02108-e268-4a8f-b42f-afb0cd78548c" }, { "name": "recurring-transactions", "item": [ { "name": "Create an estimate of the recurring transactions for an account", "id": "565dc9b8-f1c6-4bf7-9570-dc2e5ca963e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/recurring-transactions", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "recurring-transactions" ], "variable": [ { "id": "7cb58260-778d-4313-ae50-9182527103be", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "**THIS ENDPOINT IS DEPRECATED.** Estimation of recurring transactions has ben superseded by the regular transactions endpoint. Requires **accounts:read** and **transactions:read:all** scope." }, "response": [ { "id": "2947b886-f8d5-4132-9114-c2f9bccee622", "name": "Successful Recurring Transactions Response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/recurring-transactions", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "recurring-transactions" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"counterpartyId\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"amountRange\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"monthlyAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictionSource\": \"moneyhub\",\n \"monthlyAverageOnly\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ]\n },\n {\n \"counterpartyId\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"amountRange\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"monthlyAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictionSource\": \"moneyhub\",\n \"monthlyAverageOnly\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2947b886-f8d5-4132-9114-c2f9bccee622" }, { "id": "af3173c5-1cb8-4fc5-b7c8-69bd8a89273c", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/recurring-transactions", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "recurring-transactions" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-af3173c5-1cb8-4fc5-b7c8-69bd8a89273c" }, { "id": "5a40ee3d-c4a0-4f10-9ccc-bc0e4cf49c9e", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/recurring-transactions", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "recurring-transactions" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5a40ee3d-c4a0-4f10-9ccc-bc0e4cf49c9e" }, { "id": "7f636594-4344-4a26-9b13-7c68c188bc99", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/recurring-transactions", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "recurring-transactions" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7f636594-4344-4a26-9b13-7c68c188bc99" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-565dc9b8-f1c6-4bf7-9570-dc2e5ca963e0" } ], "id": "4b7086b9-2d89-4e75-9cf0-6f2d0ed5938b", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4b7086b9-2d89-4e75-9cf0-6f2d0ed5938b" }, { "name": "notification-thresholds", "item": [ { "name": "{thresholdId}", "item": [ { "name": "Update a single notification threshold", "id": "7d024344-8783-4f26-bbf5-e75b50bebfa5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "id": "241c91b1-b2cd-4e35-a977-ca36bfedb140", "key": "accountId", "value": "", "description": "(Required) The Account Id" }, { "id": "4ebd70e3-80ad-402b-8fb9-25b3595d7526", "key": "thresholdId", "value": "", "description": "(Required) The Threshold Id" } ] }, "description": "Requires **accounts:read** and either of **accounts:write** or **accounts:write:all** scopes." }, "response": [ { "id": "2cee91b4-5419-4500-b32a-a23ac8782a3e", "name": "Successful Notification Threshold Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"value\": \"\",\n \"type\": \"gt\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2cee91b4-5419-4500-b32a-a23ac8782a3e" }, { "id": "42af03c4-e1ae-4d8c-be16-fba39b19889b", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-42af03c4-e1ae-4d8c-be16-fba39b19889b" }, { "id": "5c744146-f1be-40b2-8889-fe6c71da3293", "name": "Unsuccessful Notification Threshold Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5c744146-f1be-40b2-8889-fe6c71da3293" }, { "id": "ecf3d22c-83aa-42f2-9c7f-ba58537c957c", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ecf3d22c-83aa-42f2-9c7f-ba58537c957c" }, { "id": "67f0cb94-5c1b-4016-ae2f-4dd140d71662", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-67f0cb94-5c1b-4016-ae2f-4dd140d71662" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7d024344-8783-4f26-bbf5-e75b50bebfa5" }, { "name": "Delete a single notification threshold", "id": "ff4bc401-55fd-48b7-b720-1355a6201bff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "id": "b38013d4-cd8e-40f0-8920-11825e468fa5", "key": "accountId", "value": "", "description": "(Required) The Account Id" }, { "id": "53656160-2c53-4644-850f-3292d1f4126b", "key": "thresholdId", "value": "", "description": "(Required) The Threshold Id" } ] }, "description": "Requires **accounts:read** and either of **accounts:write** or **accounts:write:all** scopes." }, "response": [ { "id": "74f64654-478a-4c02-8839-33a7c2df6e80", "name": "Successful Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-74f64654-478a-4c02-8839-33a7c2df6e80" }, { "id": "1d55329f-4bee-4cb9-b051-22818853e09d", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1d55329f-4bee-4cb9-b051-22818853e09d" }, { "id": "019bf6b4-4b8b-44a0-b000-af3b893095f1", "name": "Unsuccessful Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-019bf6b4-4b8b-44a0-b000-af3b893095f1" }, { "id": "ba509366-4d3e-4957-b293-c112b9983e4f", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ba509366-4d3e-4957-b293-c112b9983e4f" }, { "id": "2daaefd9-3742-4d55-a1b4-1804cd557f8f", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds/:thresholdId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds", ":thresholdId" ], "variable": [ { "key": "accountId" }, { "key": "thresholdId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2daaefd9-3742-4d55-a1b4-1804cd557f8f" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ff4bc401-55fd-48b7-b720-1355a6201bff" } ], "id": "1109d7d4-87b8-462e-956d-878c9aa4b254", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1109d7d4-87b8-462e-956d-878c9aa4b254" }, { "name": "Retrieve the notification thresholds for an account", "id": "76ccc1fc-3be6-4be1-a2f1-d6c44332af10", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "id": "ae1bb77e-7d47-4f9b-b695-9341055d5305", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** scope." }, "response": [ { "id": "ad5bce17-b44f-458a-acee-a44d81ff97ad", "name": "Successful Notification Thresholds Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"value\": \"\",\n \"type\": \"gt\"\n },\n {\n \"id\": \"\",\n \"value\": \"\",\n \"type\": \"lt\"\n }\n ],\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ad5bce17-b44f-458a-acee-a44d81ff97ad" }, { "id": "7aac0bb3-318a-4dab-a348-fa23a463d233", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7aac0bb3-318a-4dab-a348-fa23a463d233" }, { "id": "37bea11a-c674-44d0-9043-9ee278ec19a1", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-37bea11a-c674-44d0-9043-9ee278ec19a1" }, { "id": "e0a96b24-b7d8-4b9f-8dca-e2b607ff4d92", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e0a96b24-b7d8-4b9f-8dca-e2b607ff4d92" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-76ccc1fc-3be6-4be1-a2f1-d6c44332af10" }, { "name": "Add a notification threshold to an account", "id": "ade6be57-910e-4df1-80f7-82894d97c7d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "id": "7a9c2da6-d046-4964-b5a0-5251570a148e", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** and either of **accounts:write** or **accounts:write:all** scopes." }, "response": [ { "id": "475efd9e-13a4-4a1d-acbd-5aedd88a2714", "name": "Successful Notification Threshold Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"value\": \"\",\n \"type\": \"gt\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-475efd9e-13a4-4a1d-acbd-5aedd88a2714" }, { "id": "cdfe326a-e716-4a13-bdd4-d64add574360", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-cdfe326a-e716-4a13-bdd4-d64add574360" }, { "id": "3997d19e-efe9-461a-930c-d02085ac9cd0", "name": "Unsuccessful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3997d19e-efe9-461a-930c-d02085ac9cd0" }, { "id": "f913783a-30db-4b1e-8be6-d2e382358d2d", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"type\": \"gt\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId/notification-thresholds", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "notification-thresholds" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f913783a-30db-4b1e-8be6-d2e382358d2d" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ade6be57-910e-4df1-80f7-82894d97c7d1" } ], "id": "942e00bf-45d1-4fa0-b39d-43113edec2fe", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-942e00bf-45d1-4fa0-b39d-43113edec2fe" }, { "name": "statements", "item": [ { "name": "Retrieve the statements for an account", "id": "722b7ae1-79f2-400f-ad9f-62f772fa7716", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statements", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statements" ], "variable": [ { "id": "0c6fa958-e98b-4409-9e75-b9d653b6df27", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** and either **statements_basic:read** or **statements_detail:read** scopes." }, "response": [ { "id": "4485ffb2-650e-4350-b2cd-d524a266d7c7", "name": "Successful Statements Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statements", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statements" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"accountId\": \"\",\n \"userId\": \"\",\n \"providerStatementId\": \"\",\n \"providerAccountId\": \"\",\n \"type\": \"RegularPeriodic\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"creationDate\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"benefits\": [\n {\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n {\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n ],\n \"fees\": [\n {\n \"creditDebitIndicator\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"description\": \"\",\n \"rate\": \"\",\n \"rateType\": \"FixedRate\",\n \"frequency\": \"StatementMonthly\"\n },\n {\n \"creditDebitIndicator\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"description\": \"\",\n \"rate\": \"\",\n \"rateType\": \"BOEBaseRate\",\n \"frequency\": \"Weekly\"\n }\n ],\n \"interest\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"description\": \"\",\n \"creditDebitIndicator\": \"\",\n \"rate\": \"\",\n \"rateType\": \"Net\",\n \"frequency\": \"PerStatementDate\",\n \"type\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"description\": \"\",\n \"creditDebitIndicator\": \"\",\n \"rate\": \"\",\n \"rateType\": \"Net\",\n \"frequency\": \"Monthly\",\n \"type\": \"\"\n }\n ],\n \"amounts\": [\n {\n \"creditDebitIndicator\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"amountSubType\": \"BaseCurrency\",\n \"localAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"localAmountSubType\": \"BaseCurrency\"\n },\n {\n \"creditDebitIndicator\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"amountSubType\": \"LocalCurrency\",\n \"localAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"localAmountSubType\": \"BaseCurrency\"\n }\n ],\n \"dates\": [\n {\n \"date\": \"\",\n \"type\": \"\"\n },\n {\n \"date\": \"\",\n \"type\": \"\"\n }\n ],\n \"rates\": [\n {\n \"rate\": \"\",\n \"type\": \"\"\n },\n {\n \"rate\": \"\",\n \"type\": \"\"\n }\n ],\n \"values\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"totalValue\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"currency\": \"\"\n },\n {\n \"id\": \"\",\n \"accountId\": \"\",\n \"userId\": \"\",\n \"providerStatementId\": \"\",\n \"providerAccountId\": \"\",\n \"type\": \"RegularPeriodic\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"creationDate\": \"\",\n \"reference\": \"\",\n \"description\": \"\",\n \"benefits\": [\n {\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n {\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n ],\n \"fees\": [\n {\n \"creditDebitIndicator\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"description\": \"\",\n \"rate\": \"\",\n \"rateType\": \"LoanProviderBaseRate\",\n \"frequency\": \"StatementMonthly\"\n },\n {\n \"creditDebitIndicator\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"description\": \"\",\n \"rate\": \"\",\n \"rateType\": \"BOEBaseRate\",\n \"frequency\": \"Weekly\"\n }\n ],\n \"interest\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"description\": \"\",\n \"creditDebitIndicator\": \"\",\n \"rate\": \"\",\n \"rateType\": \"LoanProviderBaseRate\",\n \"frequency\": \"Weekly\",\n \"type\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"description\": \"\",\n \"creditDebitIndicator\": \"\",\n \"rate\": \"\",\n \"rateType\": \"BOEBaseRate\",\n \"frequency\": \"PerStatementDate\",\n \"type\": \"\"\n }\n ],\n \"amounts\": [\n {\n \"creditDebitIndicator\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"amountSubType\": \"LocalCurrency\",\n \"localAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"localAmountSubType\": \"BaseCurrency\"\n },\n {\n \"creditDebitIndicator\": \"\",\n \"type\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"amountSubType\": \"LocalCurrency\",\n \"localAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"localAmountSubType\": \"BaseCurrency\"\n }\n ],\n \"dates\": [\n {\n \"date\": \"\",\n \"type\": \"\"\n },\n {\n \"date\": \"\",\n \"type\": \"\"\n }\n ],\n \"rates\": [\n {\n \"rate\": \"\",\n \"type\": \"\"\n },\n {\n \"rate\": \"\",\n \"type\": \"\"\n }\n ],\n \"values\": [\n {\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"totalValue\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"currency\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4485ffb2-650e-4350-b2cd-d524a266d7c7" }, { "id": "f3285a17-9678-434b-ac21-efa2aa3041e5", "name": "Unauthorized - Missing or invalid access token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statements", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statements" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f3285a17-9678-434b-ac21-efa2aa3041e5" }, { "id": "162474b8-56a1-4f71-86d8-079ad76c3f59", "name": "Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statements", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statements" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-162474b8-56a1-4f71-86d8-079ad76c3f59" }, { "id": "ac90735c-f502-4540-9110-cc3dd287b40a", "name": "Not Found - Account not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statements", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statements" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ac90735c-f502-4540-9110-cc3dd287b40a" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-722b7ae1-79f2-400f-ad9f-62f772fa7716" } ], "id": "734ca93a-1d53-4ecf-81f3-54b01cf2f0bd", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-734ca93a-1d53-4ecf-81f3-54b01cf2f0bd" }, { "name": "standing-orders", "item": [ { "name": "Retrieve the standing orders for an account", "id": "b5be0a3a-4530-4275-beca-c88571399c10", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/standing-orders", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "standing-orders" ], "variable": [ { "id": "49f21d6c-3fdb-4e9f-be04-77f7459b5a0d", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** and either of **standing_orders:read** or **standing_orders_detail:read** scopes." }, "response": [ { "id": "5297ff73-8623-48f9-ad29-43dcbedd2be0", "name": "Successful Standing Orders Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/standing-orders", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "standing-orders" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"frequency\": {\n \"repeat\": \"Quarterly\",\n \"day\": \"\",\n \"week\": \"\",\n \"month\": \"\",\n \"onlyWorkDays\": \"\",\n \"region\": \"RECEIVED\"\n },\n \"status\": \"Active\",\n \"reference\": \"\",\n \"numberOfPayments\": \"\",\n \"firstPaymentDate\": \"\",\n \"nextPaymentDate\": \"\",\n \"finalPaymentDate\": \"\",\n \"firstPaymentAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"nextPaymentAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"finalPaymentAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"currency\": \"\",\n \"payee\": {\n \"name\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"frequency\": {\n \"repeat\": \"Weekly\",\n \"day\": \"\",\n \"week\": \"\",\n \"month\": \"\",\n \"onlyWorkDays\": \"\",\n \"region\": \"ENGLISH\"\n },\n \"status\": \"Active\",\n \"reference\": \"\",\n \"numberOfPayments\": \"\",\n \"firstPaymentDate\": \"\",\n \"nextPaymentDate\": \"\",\n \"finalPaymentDate\": \"\",\n \"firstPaymentAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"nextPaymentAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"finalPaymentAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"currency\": \"\",\n \"payee\": {\n \"name\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5297ff73-8623-48f9-ad29-43dcbedd2be0" }, { "id": "9e66c331-a05a-44f5-bf82-27b9b8185698", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/standing-orders", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "standing-orders" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9e66c331-a05a-44f5-bf82-27b9b8185698" }, { "id": "8e9912a5-034a-49ca-97fe-edb5752a7b47", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/standing-orders", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "standing-orders" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8e9912a5-034a-49ca-97fe-edb5752a7b47" }, { "id": "c6595a76-8857-403e-af5c-4e5f9e67bb72", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/standing-orders", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "standing-orders" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c6595a76-8857-403e-af5c-4e5f9e67bb72" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b5be0a3a-4530-4275-beca-c88571399c10" } ], "id": "43d403ab-b0fd-4b18-a777-8e9b4489461c", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-43d403ab-b0fd-4b18-a777-8e9b4489461c" }, { "name": "Retrieve a single account", "id": "f4e559b2-1e20-4c60-9125-7294a5915f16", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "id": "8465607e-c15d-42e3-8c63-05fc3e8a5ec2", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** scope. Optional scope **accounts_details:read** is needed for some extra fields such as account number and sort code. Please note: field **additionalBalances** is currently in **beta**" }, "response": [ { "id": "ffe0e53d-1685-4a60-addc-c161076fcfdb", "name": "Successful Account Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"dateAdded\": \"\",\n \"dateModified\": \"\",\n \"accountName\": \"\",\n \"type\": \"cash:current\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"InterimAvailable\"\n },\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"currency\": \"\",\n \"transactionData\": {\n \"count\": \"\",\n \"earliestDate\": \"\",\n \"lastDate\": \"\"\n },\n \"providerName\": \"\",\n \"providerReference\": \"\",\n \"connectionId\": \"DEMO:Y!`ox]yh,f|+8S*:R2LsRm}`8%!+jGWhzH[+L?V{Tew>YkXQ>oDcAl8pj}\",\n \"providerAccountId\": \"\",\n \"providerParentAccountId\": \"\",\n \"providerAccountName\": \"\",\n \"accountReference\": \"\",\n \"accountHolderName\": \"\",\n \"accountOpeningDate\": \"\",\n \"accountType\": \"personal\",\n \"productName\": \"\",\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"\"\n },\n {\n \"identification\": \"\",\n \"type\": \"\"\n }\n ],\n \"performanceScore\": {\n \"totals\": {\n \"openingBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"currentBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"contributions\": \"\",\n \"withdrawals\": \"\",\n \"nonContributionGrowth\": \"\",\n \"growthRate\": \"\",\n \"annualisedGrowthRate\": \"\"\n },\n \"months\": [\n {\n \"date\": \"9759\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n },\n {\n \"date\": \"6626\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n }\n ]\n },\n \"additionalBalances\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"InterimCleared\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ClosingBooked\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ffe0e53d-1685-4a60-addc-c161076fcfdb" }, { "id": "92583a9c-1ab7-4186-b279-04b82923f924", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-92583a9c-1ab7-4186-b279-04b82923f924" }, { "id": "1924e7fa-892d-4f66-b421-2884d11621dc", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1924e7fa-892d-4f66-b421-2884d11621dc" }, { "id": "03d060f7-5bda-4b12-b402-09e241f90095", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-03d060f7-5bda-4b12-b402-09e241f90095" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f4e559b2-1e20-4c60-9125-7294a5915f16" }, { "name": "Update a single account", "id": "f16a84c9-9f62-4bb6-86bf-7f80c7bd4a6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"variable\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "id": "aea163c4-29d8-426e-8924-75cefe766539", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **accounts:read** and **accounts:write:all** scopes." }, "response": [ { "id": "fd8f453f-e5a9-4f49-b2be-5fb41cc39e4b", "name": "Successful Account Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"variable\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"dateAdded\": \"\",\n \"dateModified\": \"\",\n \"accountName\": \"\",\n \"type\": \"cash:current\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"InterimAvailable\"\n },\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"currency\": \"\",\n \"transactionData\": {\n \"count\": \"\",\n \"earliestDate\": \"\",\n \"lastDate\": \"\"\n },\n \"providerName\": \"\",\n \"providerReference\": \"\",\n \"connectionId\": \"DEMO:Y!`ox]yh,f|+8S*:R2LsRm}`8%!+jGWhzH[+L?V{Tew>YkXQ>oDcAl8pj}\",\n \"providerAccountId\": \"\",\n \"providerParentAccountId\": \"\",\n \"providerAccountName\": \"\",\n \"accountReference\": \"\",\n \"accountHolderName\": \"\",\n \"accountOpeningDate\": \"\",\n \"accountType\": \"personal\",\n \"productName\": \"\",\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"\"\n },\n {\n \"identification\": \"\",\n \"type\": \"\"\n }\n ],\n \"performanceScore\": {\n \"totals\": {\n \"openingBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"currentBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"contributions\": \"\",\n \"withdrawals\": \"\",\n \"nonContributionGrowth\": \"\",\n \"growthRate\": \"\",\n \"annualisedGrowthRate\": \"\"\n },\n \"months\": [\n {\n \"date\": \"9759\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n },\n {\n \"date\": \"6626\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n }\n ]\n },\n \"additionalBalances\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"InterimCleared\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ClosingBooked\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fd8f453f-e5a9-4f49-b2be-5fb41cc39e4b" }, { "id": "e4daf985-f807-45ee-84a6-73cff38d2ebc", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"variable\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e4daf985-f807-45ee-84a6-73cff38d2ebc" }, { "id": "22faac4d-995e-4e0b-9cbc-5f3dea1c3c66", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"variable\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-22faac4d-995e-4e0b-9cbc-5f3dea1c3c66" }, { "id": "21f9f5a8-cf08-4950-ac42-c614393a7144", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"variable\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-21f9f5a8-cf08-4950-ac42-c614393a7144" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f16a84c9-9f62-4bb6-86bf-7f80c7bd4a6e" }, { "name": "Delete a single account", "id": "177ad92e-9feb-4e79-93e4-fc0f4cdf49e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "id": "dd9dd656-ae9f-4a05-afd5-e45eeb704b90", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "This endpoint can only be used to delete accounts created using the POST /accounts endpoint. Accounts created when connecting to a financial institution can only be deleted by removing the connection they belong to. Requires **accounts:write:all** scope." }, "response": [ { "id": "9651f16b-f18b-4a10-a9e5-3b8eae8a7ddc", "name": "Successful Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9651f16b-f18b-4a10-a9e5-3b8eae8a7ddc" }, { "id": "e3cb3abf-5d64-4b02-9255-df06bc654093", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e3cb3abf-5d64-4b02-9255-df06bc654093" }, { "id": "d485d18a-426c-4ec4-80e7-6b9d3008ee3e", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d485d18a-426c-4ec4-80e7-6b9d3008ee3e" }, { "id": "48201cf5-0496-4011-8af2-5b44d988cc95", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-48201cf5-0496-4011-8af2-5b44d988cc95" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-177ad92e-9feb-4e79-93e4-fc0f4cdf49e0" } ], "id": "89d5924f-c2a9-47ca-93b4-ca427d5d36c9", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-89d5924f-c2a9-47ca-93b4-ca427d5d36c9" }, { "name": "syncs", "item": [ { "name": "Retrieve sync information for all of a user's accounts", "id": "c8b5c1d9-31c5-4bc8-bd98-632af64fb6af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/syncs", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "syncs" ] }, "description": "Requires **accounts:read** scope." }, "response": [ { "id": "94990318-81f6-4b8f-a922-2f90feeef8b8", "name": "Successful Accounts Syncs Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/syncs", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "syncs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"accountId\": \"\",\n \"lastSuccessfulSync\": \"\"\n },\n {\n \"accountId\": \"\",\n \"lastSuccessfulSync\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-94990318-81f6-4b8f-a922-2f90feeef8b8" }, { "id": "63176db6-e9dc-47e1-aa03-6f6a68969dff", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/syncs", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "syncs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-63176db6-e9dc-47e1-aa03-6f6a68969dff" }, { "id": "6fb0bd9e-bf75-41a5-9f13-5b493101d0c4", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts/syncs", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "syncs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6fb0bd9e-bf75-41a5-9f13-5b493101d0c4" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c8b5c1d9-31c5-4bc8-bd98-632af64fb6af" } ], "id": "f6257a05-085e-4b77-a2fb-bf171a87ae27", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f6257a05-085e-4b77-a2fb-bf171a87ae27" }, { "name": "Retrieve all accounts for a user", "id": "77143685-7a70-4c6a-b218-cf94c7ba941d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts?limit=&offset=&showTransactionData=true&showPerformanceScore=true&connectionId=", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Return transaction data for the account when available", "key": "showTransactionData", "value": "true" }, { "description": "Return performance score for the account when available", "key": "showPerformanceScore", "value": "true" }, { "description": "Filter accounts by their connectionId", "key": "connectionId", "value": "" } ] }, "description": "Requires **accounts:read** scope. Optional scope **accounts_details:read** is needed for some extra fields such as account number and sort code. Please note: field **additionalBalances** is currently in **beta**" }, "response": [ { "id": "28b489ed-7262-4ab8-bf2e-0bdf8e39dc06", "name": "Successful Accounts Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts?limit=&offset=&showTransactionData=true&showPerformanceScore=true&connectionId=", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Return transaction data for the account when available", "key": "showTransactionData", "value": "true" }, { "description": "Return performance score for the account when available", "key": "showPerformanceScore", "value": "true" }, { "description": "Filter accounts by their connectionId", "key": "connectionId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"dateAdded\": \"\",\n \"dateModified\": \"\",\n \"accountName\": \"\",\n \"type\": \"mortgage:interestOnly\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ForwardAvailable\"\n },\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"variable\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"currency\": \"\",\n \"transactionData\": {\n \"count\": \"\",\n \"earliestDate\": \"\",\n \"lastDate\": \"\"\n },\n \"providerName\": \"\",\n \"providerReference\": \"\",\n \"connectionId\": \"API:zD%z*&B+(oF+*]H#*=K%59IX;Y:4qCw\\\"'Klv\",\n \"providerId\": \"DEMO\",\n \"providerAccountId\": \"\",\n \"providerParentAccountId\": \"\",\n \"providerAccountName\": \"\",\n \"accountReference\": \"\",\n \"accountHolderName\": \"\",\n \"accountOpeningDate\": \"\",\n \"accountType\": \"personal\",\n \"productName\": \"\",\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"\"\n },\n {\n \"identification\": \"\",\n \"type\": \"\"\n }\n ],\n \"performanceScore\": {\n \"totals\": {\n \"openingBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"currentBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"contributions\": \"\",\n \"withdrawals\": \"\",\n \"nonContributionGrowth\": \"\",\n \"growthRate\": \"\",\n \"annualisedGrowthRate\": \"\"\n },\n \"months\": [\n {\n \"date\": \"2148-12\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n },\n {\n \"date\": \"3278\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n }\n ]\n },\n \"additionalBalances\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"OpeningAvailable\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"OpeningBooked\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"dateAdded\": \"\",\n \"dateModified\": \"\",\n \"accountName\": \"\",\n \"type\": \"savings\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"Expected\"\n },\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"currency\": \"\",\n \"transactionData\": {\n \"count\": \"\",\n \"earliestDate\": \"\",\n \"lastDate\": \"\"\n },\n \"providerName\": \"\",\n \"providerReference\": \"\",\n \"connectionId\": \"X@`ZP1C[`-\",\n \"providerParentAccountId\": \"\",\n \"providerAccountName\": \"\",\n \"accountReference\": \"\",\n \"accountHolderName\": \"\",\n \"accountOpeningDate\": \"\",\n \"accountType\": \"personal\",\n \"productName\": \"\",\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"\"\n },\n {\n \"identification\": \"\",\n \"type\": \"\"\n }\n ],\n \"performanceScore\": {\n \"totals\": {\n \"openingBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"currentBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"contributions\": \"\",\n \"withdrawals\": \"\",\n \"nonContributionGrowth\": \"\",\n \"growthRate\": \"\",\n \"annualisedGrowthRate\": \"\"\n },\n \"months\": [\n {\n \"date\": \"1009\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n },\n {\n \"date\": \"4477-03\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n }\n ]\n },\n \"additionalBalances\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ClosingCleared\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ForwardAvailable\"\n }\n ]\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-28b489ed-7262-4ab8-bf2e-0bdf8e39dc06" }, { "id": "39fc0ef6-3907-4187-9826-bd0ef4e51be3", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts?limit=&offset=&showTransactionData=true&showPerformanceScore=true&connectionId=", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Return transaction data for the account when available", "key": "showTransactionData", "value": "true" }, { "description": "Return performance score for the account when available", "key": "showPerformanceScore", "value": "true" }, { "description": "Filter accounts by their connectionId", "key": "connectionId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-39fc0ef6-3907-4187-9826-bd0ef4e51be3" }, { "id": "b8069b8e-4874-43dd-9d5b-339623f2b60b", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts?limit=&offset=&showTransactionData=true&showPerformanceScore=true&connectionId=", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Return transaction data for the account when available", "key": "showTransactionData", "value": "true" }, { "description": "Return performance score for the account when available", "key": "showPerformanceScore", "value": "true" }, { "description": "Filter accounts by their connectionId", "key": "connectionId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b8069b8e-4874-43dd-9d5b-339623f2b60b" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-77143685-7a70-4c6a-b218-cf94c7ba941d" }, { "name": "Create a single account for a user", "id": "de0bed1b-7599-4d2f-a13b-823ab568415c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"type\": \"asset\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n },\n \"currency\": \"\",\n \"accountType\": \"personal\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"year\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"policyNumber\"\n },\n {\n \"identification\": \"\",\n \"type\": \"savingsRollNumber\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ] }, "description": "Requires **accounts:read** and **accounts:write:all** scopes." }, "response": [ { "id": "7c3993be-0112-47e5-9e06-33bfb0d17816", "name": "Successful Account Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"type\": \"asset\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n },\n \"currency\": \"\",\n \"accountType\": \"personal\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"year\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"policyNumber\"\n },\n {\n \"identification\": \"\",\n \"type\": \"savingsRollNumber\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"dateAdded\": \"\",\n \"dateModified\": \"\",\n \"accountName\": \"\",\n \"type\": \"cash:current\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"InterimAvailable\"\n },\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"month\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"currency\": \"\",\n \"transactionData\": {\n \"count\": \"\",\n \"earliestDate\": \"\",\n \"lastDate\": \"\"\n },\n \"providerName\": \"\",\n \"providerReference\": \"\",\n \"connectionId\": \"DEMO:Y!`ox]yh,f|+8S*:R2LsRm}`8%!+jGWhzH[+L?V{Tew>YkXQ>oDcAl8pj}\",\n \"providerAccountId\": \"\",\n \"providerParentAccountId\": \"\",\n \"providerAccountName\": \"\",\n \"accountReference\": \"\",\n \"accountHolderName\": \"\",\n \"accountOpeningDate\": \"\",\n \"accountType\": \"personal\",\n \"productName\": \"\",\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"\"\n },\n {\n \"identification\": \"\",\n \"type\": \"\"\n }\n ],\n \"performanceScore\": {\n \"totals\": {\n \"openingBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"currentBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"contributions\": \"\",\n \"withdrawals\": \"\",\n \"nonContributionGrowth\": \"\",\n \"growthRate\": \"\",\n \"annualisedGrowthRate\": \"\"\n },\n \"months\": [\n {\n \"date\": \"9759\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n },\n {\n \"date\": \"6626\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n }\n ]\n },\n \"additionalBalances\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"InterimCleared\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ClosingBooked\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7c3993be-0112-47e5-9e06-33bfb0d17816" }, { "id": "2fb568eb-14b5-4250-857c-ec5bda45a372", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"type\": \"asset\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n },\n \"currency\": \"\",\n \"accountType\": \"personal\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"year\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"policyNumber\"\n },\n {\n \"identification\": \"\",\n \"type\": \"savingsRollNumber\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2fb568eb-14b5-4250-857c-ec5bda45a372" }, { "id": "54e127b4-ca24-4186-922a-7ac975137f7c", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"type\": \"asset\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n },\n \"currency\": \"\",\n \"accountType\": \"personal\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"year\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"policyNumber\"\n },\n {\n \"identification\": \"\",\n \"type\": \"savingsRollNumber\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-54e127b4-ca24-4186-922a-7ac975137f7c" }, { "id": "4a6d8b8f-46d5-41ae-96ed-1f3fe689bb03", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"providerName\": \"\",\n \"type\": \"asset\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\"\n },\n \"currency\": \"\",\n \"accountType\": \"personal\",\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"fixed\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"year\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"policyNumber\"\n },\n {\n \"identification\": \"\",\n \"type\": \"savingsRollNumber\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/accounts", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4a6d8b8f-46d5-41ae-96ed-1f3fe689bb03" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-de0bed1b-7599-4d2f-a13b-823ab568415c" } ], "id": "0031738b-2761-4803-8087-c39379686393", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0031738b-2761-4803-8087-c39379686393" }, { "name": "accounts-list", "item": [ { "name": "Retrieve all accounts for a user without additional data", "id": "fde28af9-f794-43b2-a725-203d078a617c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts-list?limit=&offset=&showTransactionData=false&showPerformanceScore=false&connectionId=", "host": [ "{{baseUrl}}" ], "path": [ "accounts-list" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Return transaction data for the account when available", "key": "showTransactionData", "value": "false" }, { "description": "Return performance score for the account when available", "key": "showPerformanceScore", "value": "false" }, { "description": "Filter accounts by their connectionId", "key": "connectionId", "value": "" } ] }, "description": "Requires **accounts:read** scope. Optional scope **accounts_details:read** is needed for some extra fields such as account number and sort code. By default this endpoint does not return transaction data (when this isn't returned response times are quicker than the GET /accounts endpoint). Please note: field **additionalBalances** is currently in **beta**" }, "response": [ { "id": "a1af1ace-2521-40f9-ab7d-5df074e2f492", "name": "Successful Accounts Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts-list?limit=&offset=&showTransactionData=false&showPerformanceScore=false&connectionId=", "host": [ "{{baseUrl}}" ], "path": [ "accounts-list" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Return transaction data for the account when available", "key": "showTransactionData", "value": "false" }, { "description": "Return performance score for the account when available", "key": "showPerformanceScore", "value": "false" }, { "description": "Filter accounts by their connectionId", "key": "connectionId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"dateAdded\": \"\",\n \"dateModified\": \"\",\n \"accountName\": \"\",\n \"type\": \"investment\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"Information\"\n },\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"variable\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"year\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"currency\": \"\",\n \"transactionData\": {\n \"count\": \"\",\n \"earliestDate\": \"\",\n \"lastDate\": \"\"\n },\n \"providerName\": \"\",\n \"providerReference\": \"\",\n \"connectionId\": \"DEMO:3';\\\"HlH[hXc^k(X)X8G,H9@Q=_8g\\\\jU[{oAW\",\n \"providerId\": \"API\",\n \"providerAccountId\": \"\",\n \"providerParentAccountId\": \"\",\n \"providerAccountName\": \"\",\n \"accountReference\": \"\",\n \"accountHolderName\": \"\",\n \"accountOpeningDate\": \"\",\n \"accountType\": \"personal\",\n \"productName\": \"\",\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"\"\n },\n {\n \"identification\": \"\",\n \"type\": \"\"\n }\n ],\n \"performanceScore\": {\n \"totals\": {\n \"openingBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"currentBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"contributions\": \"\",\n \"withdrawals\": \"\",\n \"nonContributionGrowth\": \"\",\n \"growthRate\": \"\",\n \"annualisedGrowthRate\": \"\"\n },\n \"months\": [\n {\n \"date\": \"1498\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n },\n {\n \"date\": \"9095\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n }\n ]\n },\n \"additionalBalances\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"ClosingCleared\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"PreviouslyClosedBooked\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"dateAdded\": \"\",\n \"dateModified\": \"\",\n \"accountName\": \"\",\n \"type\": \"properties:buyToLet\",\n \"balance\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"OpeningCleared\"\n },\n \"details\": {\n \"AER\": \"\",\n \"APR\": \"\",\n \"sortCodeAccountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"creditLimit\": \"\",\n \"endDate\": \"\",\n \"fixedDate\": \"\",\n \"interestFreePeriod\": \"\",\n \"interestType\": \"variable\",\n \"linkedProperty\": \"\",\n \"monthlyRepayment\": \"\",\n \"overdraftLimit\": \"\",\n \"postcode\": \"\",\n \"runningCost\": \"\",\n \"runningCostPeriod\": \"year\",\n \"term\": \"\",\n \"yearlyAppreciation\": \"\"\n },\n \"currency\": \"\",\n \"transactionData\": {\n \"count\": \"\",\n \"earliestDate\": \"\",\n \"lastDate\": \"\"\n },\n \"providerName\": \"\",\n \"providerReference\": \"\",\n \"connectionId\": \"API:CAK|;fV}f7EK#Rs&.om}qf'ZG*_88MA))*r@\",\n \"providerId\": \"QH s;Pkt)^t8O$3_+9FPxxH*Fy01B Rx\",\n \"providerAccountId\": \"\",\n \"providerParentAccountId\": \"\",\n \"providerAccountName\": \"\",\n \"accountReference\": \"\",\n \"accountHolderName\": \"\",\n \"accountOpeningDate\": \"\",\n \"accountType\": \"personal\",\n \"productName\": \"\",\n \"providerAccountIdentifications\": [\n {\n \"identification\": \"\",\n \"type\": \"\"\n },\n {\n \"identification\": \"\",\n \"type\": \"\"\n }\n ],\n \"performanceScore\": {\n \"totals\": {\n \"openingBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"currentBalance\": {\n \"date\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"contributions\": \"\",\n \"withdrawals\": \"\",\n \"nonContributionGrowth\": \"\",\n \"growthRate\": \"\",\n \"annualisedGrowthRate\": \"\"\n },\n \"months\": [\n {\n \"date\": \"4510\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n },\n {\n \"date\": \"5853\",\n \"openingBalance\": \"\",\n \"nonContributionGrowth\": \"\",\n \"aer\": \"\"\n }\n ]\n },\n \"additionalBalances\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"OpeningAvailable\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"type\": \"OpeningAvailable\"\n }\n ]\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a1af1ace-2521-40f9-ab7d-5df074e2f492" }, { "id": "bad22089-6ff2-49d8-802f-3d7d9683b317", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts-list?limit=&offset=&showTransactionData=false&showPerformanceScore=false&connectionId=", "host": [ "{{baseUrl}}" ], "path": [ "accounts-list" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Return transaction data for the account when available", "key": "showTransactionData", "value": "false" }, { "description": "Return performance score for the account when available", "key": "showPerformanceScore", "value": "false" }, { "description": "Filter accounts by their connectionId", "key": "connectionId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bad22089-6ff2-49d8-802f-3d7d9683b317" }, { "id": "bd6ed800-c413-4f95-9eff-6ec4df1cfa3e", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/accounts-list?limit=&offset=&showTransactionData=false&showPerformanceScore=false&connectionId=", "host": [ "{{baseUrl}}" ], "path": [ "accounts-list" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Return transaction data for the account when available", "key": "showTransactionData", "value": "false" }, { "description": "Return performance score for the account when available", "key": "showPerformanceScore", "value": "false" }, { "description": "Filter accounts by their connectionId", "key": "connectionId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bd6ed800-c413-4f95-9eff-6ec4df1cfa3e" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fde28af9-f794-43b2-a725-203d078a617c" } ], "id": "7b2558a6-ff22-4e7f-8395-ecbaa21cc48c", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7b2558a6-ff22-4e7f-8395-ecbaa21cc48c" }, { "name": "affordability", "item": [ { "name": "confidence", "item": [ { "name": "Get the affordability confidence calculation for a user, given the account and transaction data currently available", "id": "3c391986-39c3-42cd-9c1b-d4f5b3732255", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/affordability/confidence", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "confidence" ] }, "description": "Requires **affordability:read** scope." }, "response": [ { "id": "25bb2e8a-a7a0-419c-8da0-bdf964845f56", "name": "Successful Affordability Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/confidence", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "confidence" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"confidence\": \"high\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-25bb2e8a-a7a0-419c-8da0-bdf964845f56" }, { "id": "387b7f5a-1add-4a0b-93ad-a07f33f331e3", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/confidence", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "confidence" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-387b7f5a-1add-4a0b-93ad-a07f33f331e3" }, { "id": "32cc5477-9447-485a-8571-769cad5d50e3", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/confidence", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "confidence" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-32cc5477-9447-485a-8571-769cad5d50e3" }, { "id": "949b5818-f83b-43de-8e05-8caaacace196", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/confidence", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "confidence" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-949b5818-f83b-43de-8e05-8caaacace196" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3c391986-39c3-42cd-9c1b-d4f5b3732255" } ], "id": "1f4e389d-d1e6-418a-acee-1093f68b537e", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1f4e389d-d1e6-418a-acee-1093f68b537e" }, { "name": "{reportId}", "item": [ { "name": "Get an existing affordability calculation for a user", "id": "09701648-df9b-401b-831c-77fe49e114ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/affordability/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", ":reportId" ], "variable": [ { "id": "dac4d84f-e2b6-4ea5-9025-c514728ff841", "key": "reportId", "value": "", "description": "(Required) The Report Id" } ] }, "description": "Requires **affordability:read** scope." }, "response": [ { "id": "95a6cd3f-3748-4ca4-9c10-47a3b8639a9e", "name": "Successful Affordability Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"income\": {\n \"amountConsistency\": \"\",\n \"longevity\": {\n \"consecutiveIncomeMonths\": \"\",\n \"incomePeriodLengthMonths\": \"\"\n },\n \"predicted\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"regularIncomeDetected\": \"\"\n },\n \"overdraftUseByAccount\": [\n {\n \"id\": \"\",\n \"daysInOverdraft\": \"\",\n \"earliestBalanceDate\": \"\",\n \"daysInUnarrangedOverdraft\": \"\",\n \"details\": [\n {\n \"days\": \"\",\n \"end\": \"\",\n \"minimumBalance\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"start\": \"\",\n \"unarrangedOverdraft\": {\n \"days\": \"\",\n \"details\": [\n {\n \"days\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"minimumBalance\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n ]\n }\n }\n ]\n }\n ],\n \"overview\": {\n \"discretionaryExpenses\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"fixedExpenses\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"flexibleExpenses\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"income\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"nonDiscretionaryExpenses\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"incomeIncludingTransfers\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"primaryIncomeAccountId\": \"\",\n \"riskIndicators\": {\n \"cashWithdrawals\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"gambling\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"loanRepayments\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"outgoingTransfers\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"returnedDirectDebits\": {\n \"count\": \"\",\n \"details\": [\n {\n \"category\": \"\",\n \"count\": \"\",\n \"period\": {\n \"unit\": \"days\",\n \"value\": \"\"\n },\n \"total\": {\n \"returned\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n ],\n \"periodMonths\": \"\"\n },\n \"loansOpened\": {\n \"byPeriod\": {\n \"30days\": {\n \"byType\": {\n \"bnpl\": \"\",\n \"hcstc\": \"\",\n \"dca/dmp\": \"\",\n \"secured\": \"\",\n \"unknown\": \"\",\n \"unsecured\": \"\"\n },\n \"totalByType\": {\n \"bnpl\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"hcstc\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"dca/dmp\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"secured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unknown\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unsecured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"90days\": {\n \"byType\": {\n \"bnpl\": \"\",\n \"hcstc\": \"\",\n \"dca/dmp\": \"\",\n \"secured\": \"\",\n \"unknown\": \"\",\n \"unsecured\": \"\"\n },\n \"totalByType\": {\n \"bnpl\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"hcstc\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"dca/dmp\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"secured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unknown\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unsecured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"180days\": {\n \"byType\": {\n \"bnpl\": \"\",\n \"hcstc\": \"\",\n \"dca/dmp\": \"\",\n \"secured\": \"\",\n \"unknown\": \"\",\n \"unsecured\": \"\"\n },\n \"totalByType\": {\n \"bnpl\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"hcstc\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"dca/dmp\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"secured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unknown\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unsecured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"365days\": {\n \"byType\": {\n \"bnpl\": \"\",\n \"hcstc\": \"\",\n \"dca/dmp\": \"\",\n \"secured\": \"\",\n \"unknown\": \"\",\n \"unsecured\": \"\"\n },\n \"totalByType\": {\n \"bnpl\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"hcstc\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"dca/dmp\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"secured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unknown\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unsecured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-95a6cd3f-3748-4ca4-9c10-47a3b8639a9e" }, { "id": "123fa7b9-3129-472f-a0ca-9ab5cf989b44", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-123fa7b9-3129-472f-a0ca-9ab5cf989b44" }, { "id": "65f271a8-ae10-49d1-a0c5-ae4c81b0c666", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-65f271a8-ae10-49d1-a0c5-ae4c81b0c666" }, { "id": "de19ea15-d117-4e57-ba00-cefa62f3bd7a", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-de19ea15-d117-4e57-ba00-cefa62f3bd7a" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-09701648-df9b-401b-831c-77fe49e114ad" } ], "id": "811d8187-f27d-41c4-8de8-0c7531f8dff6", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-811d8187-f27d-41c4-8de8-0c7531f8dff6" }, { "name": "income", "item": [ { "name": "{reportId}", "item": [ { "name": "Get an existing affordability income calculation for a user", "id": "636463b0-9a9b-4dc4-8d46-8a2d2595492d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/affordability/income/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income", ":reportId" ], "variable": [ { "id": "989c7da5-b57a-49fe-8415-c4f9e7ba20d5", "key": "reportId", "value": "", "description": "(Required) The Report Id" } ] }, "description": "Requires **affordability_income:read** scope." }, "response": [ { "id": "651b90d7-1184-4626-9f29-2ebdf95110ef", "name": "Successful Affordability Income Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/income/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"income\": {\n \"amountConsistency\": \"\",\n \"longevity\": {\n \"consecutiveIncomeMonths\": \"\",\n \"incomePeriodLengthMonths\": \"\"\n },\n \"predicted\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"regularIncomeDetected\": \"\"\n },\n \"overview\": {\n \"income\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"incomeIncludingTransfers\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"primaryIncomeAccountId\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-651b90d7-1184-4626-9f29-2ebdf95110ef" }, { "id": "025baf4b-e2fc-463d-8cd9-e43453d487b1", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/income/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-025baf4b-e2fc-463d-8cd9-e43453d487b1" }, { "id": "e8d46af4-2937-438e-b765-3a1c1e4b9ebf", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/income/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e8d46af4-2937-438e-b765-3a1c1e4b9ebf" }, { "id": "f17fc72d-5cec-4fe9-8f01-245ebee6d8ab", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/income/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f17fc72d-5cec-4fe9-8f01-245ebee6d8ab" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-636463b0-9a9b-4dc4-8d46-8a2d2595492d" } ], "id": "00908cb1-268d-4cf4-a315-982930dac0c1", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-00908cb1-268d-4cf4-a315-982930dac0c1" }, { "name": "List of metadata for all affordability income calculations for a user", "id": "c501120a-83f7-4668-bc9f-d53ab406fd41", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/affordability/income?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] }, "description": "Requires **affordability_income:read** scope." }, "response": [ { "id": "a38ba248-be30-429a-b608-0e5d7299c47f", "name": "Successful Affordability Income Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/income?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a38ba248-be30-429a-b608-0e5d7299c47f" }, { "id": "da21b3ce-2d5f-4c8a-8d17-93c7b4092044", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/income?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-da21b3ce-2d5f-4c8a-8d17-93c7b4092044" }, { "id": "fcb0a503-4778-4c03-b290-7f17bf2cd7f0", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/income?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fcb0a503-4778-4c03-b290-7f17bf2cd7f0" }, { "id": "d9427142-9a07-4c48-ae08-cac143406a25", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability/income?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d9427142-9a07-4c48-ae08-cac143406a25" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c501120a-83f7-4668-bc9f-d53ab406fd41" }, { "name": "Request affordability income calculation for a user", "id": "f308a5d9-6ddd-4bb6-8965-1c4ca819fa33", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability/income", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ] }, "description": "Requires **affordability_income:write** and **affordability_income:read** scopes." }, "response": [ { "id": "e038a48a-1512-4d7c-8448-c3ddcca2e4b5", "name": "Successful Affordability Income Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability/income", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"income\": {\n \"amountConsistency\": \"\",\n \"longevity\": {\n \"consecutiveIncomeMonths\": \"\",\n \"incomePeriodLengthMonths\": \"\"\n },\n \"predicted\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"regularIncomeDetected\": \"\"\n },\n \"overview\": {\n \"income\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"incomeIncludingTransfers\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"primaryIncomeAccountId\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e038a48a-1512-4d7c-8448-c3ddcca2e4b5" }, { "id": "7aa7fac5-505c-4f94-9e98-1e88c5f31ab4", "name": "Unsuccessful Response - Bad Request - Mixed account currencies", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability/income", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"subCode\": \"CURRENCY_MISMATCH\",\n \"message\": \"\",\n \"correlationId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7aa7fac5-505c-4f94-9e98-1e88c5f31ab4" }, { "id": "7e89a14e-f6e4-4075-ab4c-485bc4a652ff", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability/income", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7e89a14e-f6e4-4075-ab4c-485bc4a652ff" }, { "id": "ea6ead7a-923e-44dd-8278-1609c8ab7ec7", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability/income", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ea6ead7a-923e-44dd-8278-1609c8ab7ec7" }, { "id": "a6b8aa17-94d4-48a2-be9a-d31837814b4e", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability/income", "host": [ "{{baseUrl}}" ], "path": [ "affordability", "income" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a6b8aa17-94d4-48a2-be9a-d31837814b4e" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f308a5d9-6ddd-4bb6-8965-1c4ca819fa33" } ], "id": "8199739f-98eb-4c71-b43f-e4d2cc745360", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8199739f-98eb-4c71-b43f-e4d2cc745360" }, { "name": "List of metadata for all affordability calculations for a user", "id": "00dd1997-a81e-4578-8fda-d119e0936e85", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/affordability?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] }, "description": "Requires **affordability:read** scope." }, "response": [ { "id": "d92ceaed-ea7f-4539-863f-88317a7d6b0e", "name": "Successful Affordability Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d92ceaed-ea7f-4539-863f-88317a7d6b0e" }, { "id": "2359bddb-66e3-4831-9fbf-47db1217b048", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2359bddb-66e3-4831-9fbf-47db1217b048" }, { "id": "2720e0ff-ce9f-4771-b86d-530c1a1360c3", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2720e0ff-ce9f-4771-b86d-530c1a1360c3" }, { "id": "16e40191-34f9-4ca3-a617-dc1eec0f4768", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/affordability?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-16e40191-34f9-4ca3-a617-dc1eec0f4768" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-00dd1997-a81e-4578-8fda-d119e0936e85" }, { "name": "Request affordability calculation for a user", "id": "cb46ec98-60d9-4a5f-a106-f90f01fa21d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ] }, "description": "Requires **affordability:write** and **affordability:read** scopes." }, "response": [ { "id": "53f5dcff-2ac3-4389-a07f-b0a0295221ef", "name": "Successful Affordability Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"income\": {\n \"amountConsistency\": \"\",\n \"longevity\": {\n \"consecutiveIncomeMonths\": \"\",\n \"incomePeriodLengthMonths\": \"\"\n },\n \"predicted\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"regularIncomeDetected\": \"\"\n },\n \"overdraftUseByAccount\": [\n {\n \"id\": \"\",\n \"daysInOverdraft\": \"\",\n \"earliestBalanceDate\": \"\",\n \"daysInUnarrangedOverdraft\": \"\",\n \"details\": [\n {\n \"days\": \"\",\n \"end\": \"\",\n \"minimumBalance\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"start\": \"\",\n \"unarrangedOverdraft\": {\n \"days\": \"\",\n \"details\": [\n {\n \"days\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"minimumBalance\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n ]\n }\n }\n ]\n }\n ],\n \"overview\": {\n \"discretionaryExpenses\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"fixedExpenses\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"flexibleExpenses\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"income\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"nonDiscretionaryExpenses\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"incomeIncludingTransfers\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"primaryIncomeAccountId\": \"\",\n \"riskIndicators\": {\n \"cashWithdrawals\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"gambling\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"loanRepayments\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"outgoingTransfers\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"returnedDirectDebits\": {\n \"count\": \"\",\n \"details\": [\n {\n \"category\": \"\",\n \"count\": \"\",\n \"period\": {\n \"unit\": \"days\",\n \"value\": \"\"\n },\n \"total\": {\n \"returned\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n ],\n \"periodMonths\": \"\"\n },\n \"loansOpened\": {\n \"byPeriod\": {\n \"30days\": {\n \"byType\": {\n \"bnpl\": \"\",\n \"hcstc\": \"\",\n \"dca/dmp\": \"\",\n \"secured\": \"\",\n \"unknown\": \"\",\n \"unsecured\": \"\"\n },\n \"totalByType\": {\n \"bnpl\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"hcstc\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"dca/dmp\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"secured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unknown\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unsecured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"90days\": {\n \"byType\": {\n \"bnpl\": \"\",\n \"hcstc\": \"\",\n \"dca/dmp\": \"\",\n \"secured\": \"\",\n \"unknown\": \"\",\n \"unsecured\": \"\"\n },\n \"totalByType\": {\n \"bnpl\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"hcstc\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"dca/dmp\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"secured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unknown\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unsecured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"180days\": {\n \"byType\": {\n \"bnpl\": \"\",\n \"hcstc\": \"\",\n \"dca/dmp\": \"\",\n \"secured\": \"\",\n \"unknown\": \"\",\n \"unsecured\": \"\"\n },\n \"totalByType\": {\n \"bnpl\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"hcstc\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"dca/dmp\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"secured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unknown\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unsecured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"365days\": {\n \"byType\": {\n \"bnpl\": \"\",\n \"hcstc\": \"\",\n \"dca/dmp\": \"\",\n \"secured\": \"\",\n \"unknown\": \"\",\n \"unsecured\": \"\"\n },\n \"totalByType\": {\n \"bnpl\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"hcstc\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"dca/dmp\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"secured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unknown\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n },\n \"unsecured\": {\n \"borrowed\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"repaid\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-53f5dcff-2ac3-4389-a07f-b0a0295221ef" }, { "id": "9375e6da-e590-43ec-83c8-4edad2ffea9a", "name": "Unsuccessful Response - Bad Request - Mixed account currencies", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"subCode\": \"CURRENCY_MISMATCH\",\n \"message\": \"\",\n \"correlationId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9375e6da-e590-43ec-83c8-4edad2ffea9a" }, { "id": "6f40ef67-3889-468f-aeff-3ed4623176bb", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6f40ef67-3889-468f-aeff-3ed4623176bb" }, { "id": "69e023ba-470b-461c-b254-00353ec2a953", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-69e023ba-470b-461c-b254-00353ec2a953" }, { "id": "b5ce4ddb-c70a-4ca1-8350-262f25c2ea0b", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/affordability", "host": [ "{{baseUrl}}" ], "path": [ "affordability" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b5ce4ddb-c70a-4ca1-8350-262f25c2ea0b" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-cb46ec98-60d9-4a5f-a106-f90f01fa21d1" } ], "id": "471136e3-602b-45d6-8c90-bec4b6c7462d", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-471136e3-602b-45d6-8c90-bec4b6c7462d" }, { "name": "beneficiaries", "item": [ { "name": "{beneficiaryId}", "item": [ { "name": "Retrieve a single beneficiary", "id": "6643f1be-b433-4cff-b30b-2878370de4c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/beneficiaries/:beneficiaryId", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries", ":beneficiaryId" ], "variable": [ { "id": "d6f8a9a4-7d82-4112-bd6b-4ee212557a14", "key": "beneficiaryId", "value": "", "description": "(Required) The Beneficiary Id" } ] }, "description": "Requires **beneficiaries:read** scope. Optional scope **beneficiaries_detail:read** is needed for some extra fields such as postal address." }, "response": [ { "id": "d0b1d2ac-7648-4509-8abf-466ea7947c07", "name": "Successful Beneficiary Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/beneficiaries/:beneficiaryId", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries", ":beneficiaryId" ], "variable": [ { "key": "beneficiaryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"active\": \"\",\n \"providerAccountId\": \"\",\n \"providerBeneficiaryId\": \"\",\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"name\": \"\",\n \"reference\": \"\",\n \"accountNumber\": \"58192706\",\n \"sortCode\": \"915300\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"postalAddress\": {}\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d0b1d2ac-7648-4509-8abf-466ea7947c07" }, { "id": "1eeec53b-25ed-466e-975a-3aab5a0a7a97", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/beneficiaries/:beneficiaryId", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries", ":beneficiaryId" ], "variable": [ { "key": "beneficiaryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1eeec53b-25ed-466e-975a-3aab5a0a7a97" }, { "id": "1907fa1b-9eee-461d-a18e-5953a9482bb8", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/beneficiaries/:beneficiaryId", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries", ":beneficiaryId" ], "variable": [ { "key": "beneficiaryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1907fa1b-9eee-461d-a18e-5953a9482bb8" }, { "id": "cb510302-2540-4ea2-b1df-c4de3266607b", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/beneficiaries/:beneficiaryId", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries", ":beneficiaryId" ], "variable": [ { "key": "beneficiaryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-cb510302-2540-4ea2-b1df-c4de3266607b" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6643f1be-b433-4cff-b30b-2878370de4c8" } ], "id": "2bc25a94-7c04-4c76-b156-502e147d562c", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2bc25a94-7c04-4c76-b156-502e147d562c" }, { "name": "Retrieve all beneficiaries for a user", "id": "9b69ec79-d28e-42b5-a933-12672e41e948", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/beneficiaries?limit=&offset=&isUnique=", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Whether the beneficiaries returned include duplicates with differing references", "key": "isUnique", "value": "" } ] }, "description": "Requires **beneficiaries:read** scope. Optional scope **beneficiaries_detail:read** is needed for some extra fields such as postal address." }, "response": [ { "id": "113a24a4-d2a3-4cc6-ba8f-cb2fa49e3f24", "name": "Successful Beneficiaries Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/beneficiaries?limit=&offset=&isUnique=", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Whether the beneficiaries returned include duplicates with differing references", "key": "isUnique", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"active\": \"\",\n \"providerAccountId\": \"\",\n \"providerBeneficiaryId\": \"\",\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"name\": \"\",\n \"reference\": \"\",\n \"accountNumber\": \"76437644\",\n \"sortCode\": \"267279\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"postalAddress\": {}\n },\n {\n \"id\": \"\",\n \"active\": \"\",\n \"providerAccountId\": \"\",\n \"providerBeneficiaryId\": \"\",\n \"accountId\": \"\",\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"name\": \"\",\n \"reference\": \"\",\n \"accountNumber\": \"24595620\",\n \"sortCode\": \"348781\",\n \"iban\": \"\",\n \"pan\": \"\",\n \"postalAddress\": {}\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-113a24a4-d2a3-4cc6-ba8f-cb2fa49e3f24" }, { "id": "dbfcde19-d16e-4a45-be3b-c0827400cac9", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/beneficiaries?limit=&offset=&isUnique=", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Whether the beneficiaries returned include duplicates with differing references", "key": "isUnique", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-dbfcde19-d16e-4a45-be3b-c0827400cac9" }, { "id": "c1db9bc0-4af3-4201-b183-464a6c498f1f", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/beneficiaries?limit=&offset=&isUnique=", "host": [ "{{baseUrl}}" ], "path": [ "beneficiaries" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Whether the beneficiaries returned include duplicates with differing references", "key": "isUnique", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c1db9bc0-4af3-4201-b183-464a6c498f1f" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9b69ec79-d28e-42b5-a933-12672e41e948" } ], "id": "54b3c885-d2ed-467d-8b22-bc593210265c", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-54b3c885-d2ed-467d-8b22-bc593210265c" }, { "name": "global-counterparties", "item": [ { "name": "Retrieve global counterparties", "id": "b721654d-6a5d-4249-8099-facfae327076", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/global-counterparties?limit=&offset=&counterpartiesVersion=v3", "host": [ "{{baseUrl}}" ], "path": [ "global-counterparties" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v3" } ] }, "description": "Retrieves list of global counterparties. The counterpartiesVersion query param can be used to get different versions. For more info refer to https://docs.moneyhubenterprise.com/docs/counterparties-2" }, "response": [ { "id": "b31f5cb9-ee5e-457f-b322-1be1986d3561", "name": "Successful Counterparties Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/global-counterparties?limit=&offset=&counterpartiesVersion=v3", "host": [ "{{baseUrl}}" ], "path": [ "global-counterparties" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v3" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"parentName\": \"\",\n \"fullCompanyName\": \"\",\n \"logoUrl\": \"\",\n \"website\": \"\",\n \"merchantCategoryCode\": \"\",\n \"merchantCategoryDescription\": \"\",\n \"registeredLocation\": \"\",\n \"categoryId\": \"\",\n \"analyticalCategory\": \"\",\n \"transactionCategoryId\": \"\",\n \"transactionCategory\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"parentName\": \"\",\n \"fullCompanyName\": \"\",\n \"logoUrl\": \"\",\n \"website\": \"\",\n \"merchantCategoryCode\": \"\",\n \"merchantCategoryDescription\": \"\",\n \"registeredLocation\": \"\",\n \"categoryId\": \"\",\n \"analyticalCategory\": \"\",\n \"transactionCategoryId\": \"\",\n \"transactionCategory\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b31f5cb9-ee5e-457f-b322-1be1986d3561" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b721654d-6a5d-4249-8099-facfae327076" } ], "id": "5b28e8dc-5531-4815-929d-c0a48a639a61", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5b28e8dc-5531-4815-929d-c0a48a639a61" }, { "name": "transactions", "item": [ { "name": "unenriched", "item": [ { "name": "{transactionId}", "item": [ { "name": "Retrieve a single transaction - does not include data-enriched transaction properties", "id": "18b42e6d-d0f5-4756-9827-061b1af5f079", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched", ":transactionId" ], "variable": [ { "id": "fbb5bcc6-6dad-4cb0-82d8-224fcfc20995", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:read:all** or **transactions_unenriched:read:all** scopes." }, "response": [ { "id": "95dc8f2d-afde-4782-b0aa-5fa563f4f3d2", "name": "Successful Transaction Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"dateModified\": \"\",\n \"id\": \"\",\n \"longDescription\": \"\",\n \"status\": \"posted\",\n \"accountId\": \"\",\n \"dateCreated\": \"\",\n \"valueDate\": \"\",\n \"providerId\": \"\",\n \"transactionCode\": {\n \"code\": \"\",\n \"subCode\": \"\"\n },\n \"proprietaryTransactionCode\": {\n \"code\": \"\",\n \"issuer\": \"\"\n },\n \"balance\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"balanceType\": \"\",\n \"statementReference\": \"\",\n \"merchantName\": \"\",\n \"merchantCategoryCode\": \"\",\n \"cardInstrument\": {\n \"name\": \"\",\n \"pan\": \"\",\n \"cardSchemeName\": \"VISA\",\n \"authorisationType\": \"None\"\n },\n \"creditorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"creditorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"amet1\": true,\n \"officia_f\": 35813782.877367705,\n \"dolore1\": \"ut sunt\"\n }\n },\n \"debtorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"debtorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"non__ca\": -84450659.48552868,\n \"cupidatat3\": \"minim in aute\"\n }\n },\n \"transactionReference\": \"\",\n \"transactionInformation\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-95dc8f2d-afde-4782-b0aa-5fa563f4f3d2" }, { "id": "8f46fd5a-bf41-4119-8cf0-5ea3757f9258", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8f46fd5a-bf41-4119-8cf0-5ea3757f9258" }, { "id": "b88759c2-e32d-4c11-ae94-c3fc36795c39", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b88759c2-e32d-4c11-ae94-c3fc36795c39" }, { "id": "f3698fe7-2f40-4c42-9e68-bb0113312d09", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f3698fe7-2f40-4c42-9e68-bb0113312d09" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-18b42e6d-d0f5-4756-9827-061b1af5f079" } ], "id": "b9ec000c-7503-4d5c-bc67-c22e9e55c716", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b9ec000c-7503-4d5c-bc67-c22e9e55c716" }, { "name": "Retrieve all transactions for a user - does not include data-enriched transaction properties", "id": "a5b12d11-5885-4839-a372-5fba53da95fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&accountId=&accountIds=,&creditDebitIndicator=credit&onlyCount=false", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions by", "key": "text", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" } ] }, "description": "Requires **transactions:read:all** or **transactions_unenriched:read:all** scope. Transactions usually start around the account opening date however in most cases we only retrive the last 12 months before the connection was created. The Opening Date is available at the /accounts endpoint." }, "response": [ { "id": "c6f0ae6b-a7ea-49c2-85c0-c54263c23dc3", "name": "Successful Transactions Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&accountId=&accountIds=,&creditDebitIndicator=credit&onlyCount=false", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions by", "key": "text", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"dateModified\": \"\",\n \"id\": \"\",\n \"longDescription\": \"\",\n \"status\": \"pending\",\n \"accountId\": \"\",\n \"dateCreated\": \"\",\n \"valueDate\": \"\",\n \"providerId\": \"\",\n \"transactionCode\": {\n \"code\": \"\",\n \"subCode\": \"\"\n },\n \"proprietaryTransactionCode\": {\n \"code\": \"\",\n \"issuer\": \"\"\n },\n \"balance\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"balanceType\": \"\",\n \"statementReference\": \"\",\n \"merchantName\": \"\",\n \"merchantCategoryCode\": \"\",\n \"cardInstrument\": {\n \"name\": \"\",\n \"pan\": \"\",\n \"cardSchemeName\": \"S\",\n \"authorisationType\": \"None\"\n },\n \"creditorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"creditorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"aute_0\": \"cillum nisi\",\n \"anim_8\": \"nisi dolor quis minim\"\n }\n },\n \"debtorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"debtorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"tempor_07c\": \"Excepteur laborum\",\n \"inc\": -8989210.540548503\n }\n },\n \"transactionReference\": \"\",\n \"transactionInformation\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"date\": \"\",\n \"dateModified\": \"\",\n \"id\": \"\",\n \"longDescription\": \"\",\n \"status\": \"posted\",\n \"accountId\": \"\",\n \"dateCreated\": \"\",\n \"valueDate\": \"\",\n \"providerId\": \"\",\n \"transactionCode\": {\n \"code\": \"\",\n \"subCode\": \"\"\n },\n \"proprietaryTransactionCode\": {\n \"code\": \"\",\n \"issuer\": \"\"\n },\n \"balance\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"balanceType\": \"\",\n \"statementReference\": \"\",\n \"merchantName\": \"\",\n \"merchantCategoryCode\": \"\",\n \"cardInstrument\": {\n \"name\": \"\",\n \"pan\": \"\",\n \"cardSchemeName\": \"VISA\",\n \"authorisationType\": \"Contactless\"\n },\n \"creditorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"creditorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"qui_ff\": false,\n \"sunt_\": true,\n \"irure_e\": true,\n \"veniamdd4\": \"do\"\n }\n },\n \"debtorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"debtorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"culpa5\": true\n }\n },\n \"transactionReference\": \"\",\n \"transactionInformation\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c6f0ae6b-a7ea-49c2-85c0-c54263c23dc3" }, { "id": "a23fcada-3a1a-4f03-bb79-5612af7e24f8", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&accountId=&accountIds=,&creditDebitIndicator=credit&onlyCount=false", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions by", "key": "text", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a23fcada-3a1a-4f03-bb79-5612af7e24f8" }, { "id": "66c41305-f56d-469f-8f7d-7bbdbb1e7d4c", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&accountId=&accountIds=,&creditDebitIndicator=credit&onlyCount=false", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions by", "key": "text", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-66c41305-f56d-469f-8f7d-7bbdbb1e7d4c" }, { "id": "7e5b7404-5552-4fb6-ae90-54d344200d90", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/unenriched?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&accountId=&accountIds=,&creditDebitIndicator=credit&onlyCount=false", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "unenriched" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions by", "key": "text", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7e5b7404-5552-4fb6-ae90-54d344200d90" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a5b12d11-5885-4839-a372-5fba53da95fc" } ], "id": "a912d9e9-cb34-49fd-9a87-b1a5822dbe9d", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a912d9e9-cb34-49fd-9a87-b1a5822dbe9d" }, { "name": "{transactionId}", "item": [ { "name": "files", "item": [ { "name": "{fileId}", "item": [ { "name": "Retrieve a transactions attachment", "id": "ed8bce6f-18d4-4b31-9bf9-aa9507a9a1c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "id": "f1889db7-c475-4125-9fba-ad0a3b0b6ad4", "key": "transactionId", "value": "", "description": "(Required) The transaction id" }, { "id": "3bb1fc30-e4d2-4aeb-94be-70fa732ee74f", "key": "fileId", "value": "", "description": "(Required) The file id" } ] }, "description": "Requires **transactions:read:all** scope." }, "response": [ { "id": "0180d934-4308-4bb1-b5d2-3a230f8b168f", "name": "Successful Transaction File Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "key": "transactionId" }, { "key": "fileId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"fileType\": \"\",\n \"fileName\": \"\",\n \"url\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0180d934-4308-4bb1-b5d2-3a230f8b168f" }, { "id": "0a7ad9e4-5733-4442-9ae6-3a05869a32af", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "key": "transactionId" }, { "key": "fileId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0a7ad9e4-5733-4442-9ae6-3a05869a32af" }, { "id": "12f2591a-6480-4947-8209-1e4a7199e6ae", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "key": "transactionId" }, { "key": "fileId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-12f2591a-6480-4947-8209-1e4a7199e6ae" }, { "id": "c3a214b4-ad3e-48c7-89de-1622e586b5fb", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "key": "transactionId" }, { "key": "fileId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c3a214b4-ad3e-48c7-89de-1622e586b5fb" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ed8bce6f-18d4-4b31-9bf9-aa9507a9a1c1" }, { "name": "Delete a single attachment on a transaction", "id": "fd93c1c6-9eb4-43f5-bb34-572dc606fb35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "id": "0496237e-eab6-4632-a420-ea2ae181f623", "key": "transactionId", "value": "", "description": "(Required) The transaction id" }, { "id": "7d2d0bcb-8a2a-4461-ac46-b8840ef9bf62", "key": "fileId", "value": "", "description": "(Required) The file id" } ] }, "description": "Requires **transactions:read:all** and either of **transactions:write** or **transactions:write:all** scopes." }, "response": [ { "id": "6635c957-e459-4a63-a175-2fba4d11ab11", "name": "Successful Transaction Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "key": "transactionId" }, { "key": "fileId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6635c957-e459-4a63-a175-2fba4d11ab11" }, { "id": "03d86022-cf12-4220-bb31-988edd49c16b", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "key": "transactionId" }, { "key": "fileId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-03d86022-cf12-4220-bb31-988edd49c16b" }, { "id": "bdc0c660-ede9-4b5d-89a2-82e1c6e835ec", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "key": "transactionId" }, { "key": "fileId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bdc0c660-ede9-4b5d-89a2-82e1c6e835ec" }, { "id": "15be63a3-c0e0-4c03-bc00-f1a374325aa7", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files", ":fileId" ], "variable": [ { "key": "transactionId" }, { "key": "fileId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-15be63a3-c0e0-4c03-bc00-f1a374325aa7" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fd93c1c6-9eb4-43f5-bb34-572dc606fb35" } ], "id": "422bf878-3c51-40c4-92cd-6427f73afb29", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-422bf878-3c51-40c4-92cd-6427f73afb29" }, { "name": "Retrieve a transactions attachments", "id": "26dd1b0d-658e-4e12-9cd9-9571aa9fcdb3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "id": "7683f1aa-e831-41de-a8f2-551dcad20990", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:read:all** scope." }, "response": [ { "id": "f863941e-1143-4d5e-8256-49aa65adfb6a", "name": "Successful Transaction File Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"fileType\": \"\",\n \"fileName\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"fileType\": \"\",\n \"fileName\": \"\",\n \"url\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f863941e-1143-4d5e-8256-49aa65adfb6a" }, { "id": "29df2c86-5000-4343-a933-730da0eb4eeb", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-29df2c86-5000-4343-a933-730da0eb4eeb" }, { "id": "36aa57d9-8e0a-42d8-997b-03af5a47f8e9", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-36aa57d9-8e0a-42d8-997b-03af5a47f8e9" }, { "id": "bf640a62-a307-4762-a5c9-702ebafe6b58", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bf640a62-a307-4762-a5c9-702ebafe6b58" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-26dd1b0d-658e-4e12-9cd9-9571aa9fcdb3" }, { "name": "Add an attachment to a transaction", "id": "448a442d-083b-446b-8bbb-9ca8b3e248bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) File to upload, limit of 10MB and must be an image or PDF.", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "id": "7842341e-a933-4b0a-b785-180e52460efb", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:read:all** and either of **transactions:write** or **transactions:write:all** scopes." }, "response": [ { "id": "1936da03-8972-491e-9e8c-f6c7a4931e83", "name": "Successful Transaction Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) File to upload, limit of 10MB and must be an image or PDF.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"fileType\": \"\",\n \"fileName\": \"\",\n \"url\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1936da03-8972-491e-9e8c-f6c7a4931e83" }, { "id": "2b641ebf-2713-43cb-a853-73582efb92bf", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) File to upload, limit of 10MB and must be an image or PDF.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2b641ebf-2713-43cb-a853-73582efb92bf" }, { "id": "0d009d32-c87f-4220-9811-7e75c243aaba", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) File to upload, limit of 10MB and must be an image or PDF.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0d009d32-c87f-4220-9811-7e75c243aaba" }, { "id": "01dd2b45-e21a-4947-b3a6-de443cc64a71", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) File to upload, limit of 10MB and must be an image or PDF.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/files", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "files" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-01dd2b45-e21a-4947-b3a6-de443cc64a71" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-448a442d-083b-446b-8bbb-9ca8b3e248bb" } ], "id": "b8db25ec-c4a6-4e03-a388-107c96c97bad", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b8db25ec-c4a6-4e03-a388-107c96c97bad" }, { "name": "splits", "item": [ { "name": "{splitId}", "item": [ { "name": "Patch a transaction split", "id": "6e7b0c66-5ecb-459e-b909-88e305fc6b65", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"std:-uj\",\n \"description\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits/:splitId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits", ":splitId" ], "variable": [ { "id": "1276426e-694f-4246-8093-fde3a8413104", "key": "transactionId", "value": "", "description": "(Required) The transaction id" }, { "id": "423a4bc0-cd9d-4a9b-8c19-ea756922aabf", "key": "splitId", "value": "", "description": "(Required) The split id" } ] }, "description": "Requires **transactions:write:all** scope." }, "response": [ { "id": "294affef-a4c1-4162-b6ab-5dcc006f6c68", "name": "Successful Transaction Splits Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"std:-uj\",\n \"description\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits/:splitId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits", ":splitId" ], "variable": [ { "key": "transactionId" }, { "key": "splitId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"cus:y---T----\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"std:---v---W\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-294affef-a4c1-4162-b6ab-5dcc006f6c68" }, { "id": "e53c2aa8-1a77-4ffc-bf18-d6b9bca009ea", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"std:-uj\",\n \"description\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits/:splitId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits", ":splitId" ], "variable": [ { "key": "transactionId" }, { "key": "splitId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e53c2aa8-1a77-4ffc-bf18-d6b9bca009ea" }, { "id": "79e7ba3d-d244-41db-bf4c-c31864e78bbe", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"std:-uj\",\n \"description\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits/:splitId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits", ":splitId" ], "variable": [ { "key": "transactionId" }, { "key": "splitId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-79e7ba3d-d244-41db-bf4c-c31864e78bbe" }, { "id": "88e634a0-694c-40c5-86e8-d3cf7d1fb49e", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"std:-uj\",\n \"description\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits/:splitId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits", ":splitId" ], "variable": [ { "key": "transactionId" }, { "key": "splitId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-88e634a0-694c-40c5-86e8-d3cf7d1fb49e" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6e7b0c66-5ecb-459e-b909-88e305fc6b65" } ], "id": "31f6fd83-301b-4f72-a945-3b29dac86806", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-31f6fd83-301b-4f72-a945-3b29dac86806" }, { "name": "Retrieve a transactions splits", "id": "48c45382-934f-4491-a5dd-e38c2693a077", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "id": "a38ca0ea-b7f2-4865-9dc3-ef3c39dfde73", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:read:all** scope." }, "response": [ { "id": "a1c73e51-02ac-4209-bf18-6f3148513662", "name": "Successful Transaction Splits Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"cus:ho--28\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"std:---I\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a1c73e51-02ac-4209-bf18-6f3148513662" }, { "id": "c0e8eb9c-7816-44a5-bfc4-d81656fbec35", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c0e8eb9c-7816-44a5-bfc4-d81656fbec35" }, { "id": "e4ae86d8-ec6a-404a-9e01-19291edc3f4e", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e4ae86d8-ec6a-404a-9e01-19291edc3f4e" }, { "id": "45464a5a-f673-4676-8515-e1a3d82c1954", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-45464a5a-f673-4676-8515-e1a3d82c1954" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-48c45382-934f-4491-a5dd-e38c2693a077" }, { "name": "Split a transaction", "id": "6c4f86ad-46c7-4179-80f7-fed9039c4bba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"amount\": \"\",\n \"categoryId\": \"std:-pPZF\",\n \"description\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": \"\",\n \"categoryId\": \"cus:-e-W--8w\",\n \"description\": \"\",\n \"projectId\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "id": "e56c024e-f564-4895-84fd-a19d1d079b70", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:write:all** scope." }, "response": [ { "id": "4f8af29f-26c2-40ed-bf4b-fd272efd1456", "name": "Successful Transaction Splits Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"amount\": \"\",\n \"categoryId\": \"std:-pPZF\",\n \"description\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": \"\",\n \"categoryId\": \"cus:-e-W--8w\",\n \"description\": \"\",\n \"projectId\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"cus:y---T----\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"std:---v---W\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4f8af29f-26c2-40ed-bf4b-fd272efd1456" }, { "id": "57ea1c47-9dd0-4cff-b9a8-92614bb0b2ac", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"amount\": \"\",\n \"categoryId\": \"std:-pPZF\",\n \"description\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": \"\",\n \"categoryId\": \"cus:-e-W--8w\",\n \"description\": \"\",\n \"projectId\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-57ea1c47-9dd0-4cff-b9a8-92614bb0b2ac" }, { "id": "326af517-066b-4e2f-af2c-7e2161d84e26", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"amount\": \"\",\n \"categoryId\": \"std:-pPZF\",\n \"description\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": \"\",\n \"categoryId\": \"cus:-e-W--8w\",\n \"description\": \"\",\n \"projectId\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-326af517-066b-4e2f-af2c-7e2161d84e26" }, { "id": "7849c000-227f-4b5a-926d-1e969b748c3a", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"amount\": \"\",\n \"categoryId\": \"std:-pPZF\",\n \"description\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": \"\",\n \"categoryId\": \"cus:-e-W--8w\",\n \"description\": \"\",\n \"projectId\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7849c000-227f-4b5a-926d-1e969b748c3a" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6c4f86ad-46c7-4179-80f7-fed9039c4bba" }, { "name": "Merge split transactions", "id": "d20834c8-70c1-4b91-b4a2-4260ea958d8e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "id": "fe8e9931-aa64-4f81-8a44-9137bf1ed591", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:write:all** scope." }, "response": [ { "id": "36b2238f-970b-4229-8517-5ed6ab4cbe4e", "name": "Successful Transaction Splits Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-36b2238f-970b-4229-8517-5ed6ab4cbe4e" }, { "id": "6afd3549-93d8-4b8c-b4b0-08338c1c05a1", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6afd3549-93d8-4b8c-b4b0-08338c1c05a1" }, { "id": "5d6483ac-9153-4270-8312-aaa5cdcddcb8", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5d6483ac-9153-4270-8312-aaa5cdcddcb8" }, { "id": "a13a6d6d-d146-4c14-ba4f-e3f012f28ff5", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/splits", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "splits" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a13a6d6d-d146-4c14-ba4f-e3f012f28ff5" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d20834c8-70c1-4b91-b4a2-4260ea958d8e" } ], "id": "2f557eb9-5d1a-4642-a43b-26e6dd514350", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2f557eb9-5d1a-4642-a43b-26e6dd514350" }, { "name": "Retrieve a single transaction that has been enriched with our categorisation engine", "id": "0ecf4379-8f7c-4006-b8c4-b3987a0276a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "id": "81161619-83d7-44f2-be87-e86943aa91f6", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:read:all** scope." }, "response": [ { "id": "b3823c05-2d07-442e-bb74-7a5859eb05e5", "name": "Successful Transaction Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"categoryId\": \"cus:-Rs------\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"dateModified\": \"\",\n \"id\": \"\",\n \"longDescription\": \"\",\n \"notes\": \"\",\n \"shortDescription\": \"\",\n \"status\": \"posted\",\n \"accountId\": \"\",\n \"dateCreated\": \"\",\n \"valueDate\": \"\",\n \"providerId\": \"\",\n \"counterpartyId\": \"\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.tGvac\"\n },\n \"splits\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"cus:-ni-u---g6-\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"std:I-QYR5n\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n }\n ],\n \"transactionCode\": {\n \"code\": \"\",\n \"subCode\": \"\"\n },\n \"proprietaryTransactionCode\": {\n \"code\": \"\",\n \"issuer\": \"\"\n },\n \"balance\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"balanceType\": \"\",\n \"statementReference\": \"\",\n \"merchantName\": \"\",\n \"merchantCategoryCode\": \"\",\n \"cardInstrument\": {\n \"name\": \"\",\n \"pan\": \"\",\n \"cardSchemeName\": \"VISA\",\n \"authorisationType\": \"Ugbwf\"\n },\n \"creditorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"creditorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"inb\": false,\n \"dolor_2b6\": \"tempor do ea \",\n \"et_9\": \"eiusmod labore commodo\"\n }\n },\n \"debtorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"debtorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"ina1\": \"elit consequat cup\",\n \"nisi_16_\": 19179203\n }\n },\n \"transactionReference\": \"\",\n \"transactionInformation\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b3823c05-2d07-442e-bb74-7a5859eb05e5" }, { "id": "3ee2bf0c-3e26-446a-baed-7e951f1bd621", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3ee2bf0c-3e26-446a-baed-7e951f1bd621" }, { "id": "42073b50-bc97-441a-a628-bdcd03e753ea", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-42073b50-bc97-441a-a628-bdcd03e753ea" }, { "id": "a6b2aecb-63a8-419f-954e-42ef27dacde4", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a6b2aecb-63a8-419f-954e-42ef27dacde4" }, { "id": "0d0e15cf-a9aa-47f4-9358-208e067d0f3c", "name": "Unsuccessful Response - Too Many Requests - Rate limit has been reached", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId?counterpartiesVersion=v2", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "query": [ { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" } ], "variable": [ { "key": "transactionId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"retryAfterSecs\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0d0e15cf-a9aa-47f4-9358-208e067d0f3c" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0ecf4379-8f7c-4006-b8c4-b3987a0276a5" }, { "name": "Update a single transaction", "id": "3ff47664-62b5-4031-be93-e395e82b6d59", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"cus:-d---p\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.qanDPRsx\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "id": "3b84c612-0b66-4e59-a400-51d2cbcc02f9", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:read:all** and either of **transactions:write** or **transactions:write:all** scopes." }, "response": [ { "id": "436dab15-723e-4236-afa4-c1f039c1ebc1", "name": "Successful Transaction Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"cus:-d---p\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.qanDPRsx\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"categoryId\": \"cus:-Rs------\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"dateModified\": \"\",\n \"id\": \"\",\n \"longDescription\": \"\",\n \"notes\": \"\",\n \"shortDescription\": \"\",\n \"status\": \"posted\",\n \"accountId\": \"\",\n \"dateCreated\": \"\",\n \"valueDate\": \"\",\n \"providerId\": \"\",\n \"counterpartyId\": \"\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.tGvac\"\n },\n \"splits\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"cus:-ni-u---g6-\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"std:I-QYR5n\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n }\n ],\n \"transactionCode\": {\n \"code\": \"\",\n \"subCode\": \"\"\n },\n \"proprietaryTransactionCode\": {\n \"code\": \"\",\n \"issuer\": \"\"\n },\n \"balance\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"balanceType\": \"\",\n \"statementReference\": \"\",\n \"merchantName\": \"\",\n \"merchantCategoryCode\": \"\",\n \"cardInstrument\": {\n \"name\": \"\",\n \"pan\": \"\",\n \"cardSchemeName\": \"VISA\",\n \"authorisationType\": \"Ugbwf\"\n },\n \"creditorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"creditorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"inb\": false,\n \"dolor_2b6\": \"tempor do ea \",\n \"et_9\": \"eiusmod labore commodo\"\n }\n },\n \"debtorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"debtorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"ina1\": \"elit consequat cup\",\n \"nisi_16_\": 19179203\n }\n },\n \"transactionReference\": \"\",\n \"transactionInformation\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-436dab15-723e-4236-afa4-c1f039c1ebc1" }, { "id": "052d5756-1f08-4691-9929-034f45495002", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"cus:-d---p\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.qanDPRsx\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-052d5756-1f08-4691-9929-034f45495002" }, { "id": "d32fce2b-c960-4c93-a3fb-03a3f349dbad", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"cus:-d---p\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.qanDPRsx\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d32fce2b-c960-4c93-a3fb-03a3f349dbad" }, { "id": "3069051a-8403-4788-bfcc-8c1cd0a60fb4", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"cus:-d---p\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.qanDPRsx\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3069051a-8403-4788-bfcc-8c1cd0a60fb4" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3ff47664-62b5-4031-be93-e395e82b6d59" }, { "name": "Delete a single transaction", "id": "7e49ae4a-f952-418d-96ed-6aa74c517fe0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "id": "c2e5c821-3d1e-4508-b7db-55e603392625", "key": "transactionId", "value": "", "description": "(Required) The transaction id" } ] }, "description": "Requires **transactions:write:all** scope." }, "response": [ { "id": "ae787e5b-bf99-4083-aa85-6de2fb0dfc61", "name": "Successful Transaction Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ae787e5b-bf99-4083-aa85-6de2fb0dfc61" }, { "id": "9a93cb2a-f18e-450e-8810-95337c4abad5", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9a93cb2a-f18e-450e-8810-95337c4abad5" }, { "id": "8dc2e28f-5411-4f52-af7e-28fb5be0d1be", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8dc2e28f-5411-4f52-af7e-28fb5be0d1be" }, { "id": "73f51e13-aa7b-454c-8eb5-2e2c0f4ec88e", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-73f51e13-aa7b-454c-8eb5-2e2c0f4ec88e" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7e49ae4a-f952-418d-96ed-6aa74c517fe0" } ], "id": "7bd10b87-6132-423a-8a3d-c140444abb69", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7bd10b87-6132-423a-8a3d-c140444abb69" }, { "name": "Retrieve all transactions for a user that have been enriched with our categorisation engine", "id": "5f09b409-0ffe-44d7-aa41-257bd2246e8d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&categoryId=&accountId=&accountIds=,&projectId=&projectIds=,&creditDebitIndicator=credit&hasProject=&onlyCount=false&contains=&hasEnhancedCategory=&counterpartyIds=,&counterpartyIdsV2=,&counterpartiesVersion=v2&enhancedCategories=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions/notes by", "key": "text", "value": "" }, { "description": "The category id to filter transactions by", "key": "categoryId", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "The project id to filter transactions by", "key": "projectId", "value": "" }, { "description": "The project ids to filter transactions by", "key": "projectIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Filter on whether transaction has an attached project", "key": "hasProject", "value": "" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" }, { "description": "Filter on the beginning of words of a transaction's clean description or beginning of transaction amount", "key": "contains", "value": "" }, { "description": "A property to check exists within a transaction", "key": "hasEnhancedCategory", "value": "" }, { "description": "Filter on the transaction's counterparty Id", "key": "counterpartyIds", "value": "," }, { "description": "Filter on the transaction's counterparty Id (Deprecated)", "key": "counterpartyIdsV2", "value": "," }, { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" }, { "description": "An enhanced category to filter transactions by in the form of ${categoryField}:${categoryValue}", "key": "enhancedCategories", "value": "" } ] }, "description": "Requires **transactions:read:all** scope. Transactions usually start around the account opening date however in most cases we only retrive the last 12 months before the connection was created. The Opening Date is available at the /accounts endpoint." }, "response": [ { "id": "56578079-8c64-4bd1-b6a0-57a63b9e1fbe", "name": "Successful Transactions Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&categoryId=&accountId=&accountIds=,&projectId=&projectIds=,&creditDebitIndicator=credit&hasProject=&onlyCount=false&contains=&hasEnhancedCategory=&counterpartyIds=,&counterpartyIdsV2=,&counterpartiesVersion=v2&enhancedCategories=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions/notes by", "key": "text", "value": "" }, { "description": "The category id to filter transactions by", "key": "categoryId", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "The project id to filter transactions by", "key": "projectId", "value": "" }, { "description": "The project ids to filter transactions by", "key": "projectIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Filter on whether transaction has an attached project", "key": "hasProject", "value": "" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" }, { "description": "Filter on the beginning of words of a transaction's clean description or beginning of transaction amount", "key": "contains", "value": "" }, { "description": "A property to check exists within a transaction", "key": "hasEnhancedCategory", "value": "" }, { "description": "Filter on the transaction's counterparty Id", "key": "counterpartyIds", "value": "," }, { "description": "Filter on the transaction's counterparty Id (Deprecated)", "key": "counterpartyIdsV2", "value": "," }, { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" }, { "description": "An enhanced category to filter transactions by in the form of ${categoryField}:${categoryValue}", "key": "enhancedCategories", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"categoryId\": \"cus:vxC-mHT-TS-\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"dateModified\": \"\",\n \"id\": \"\",\n \"longDescription\": \"\",\n \"notes\": \"\",\n \"shortDescription\": \"\",\n \"status\": \"pending\",\n \"accountId\": \"\",\n \"dateCreated\": \"\",\n \"valueDate\": \"\",\n \"providerId\": \"\",\n \"counterpartyId\": \"\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.sowdZK\"\n },\n \"splits\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"std:--8----P\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"cus:-\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n }\n ],\n \"transactionCode\": {\n \"code\": \"\",\n \"subCode\": \"\"\n },\n \"proprietaryTransactionCode\": {\n \"code\": \"\",\n \"issuer\": \"\"\n },\n \"balance\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"balanceType\": \"\",\n \"statementReference\": \"\",\n \"merchantName\": \"\",\n \"merchantCategoryCode\": \"\",\n \"cardInstrument\": {\n \"name\": \"\",\n \"pan\": \"\",\n \"cardSchemeName\": \"Discover\",\n \"authorisationType\": \"Contactless\"\n },\n \"creditorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"creditorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"eu47\": true\n }\n },\n \"debtorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"debtorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"proident7\": 46273038,\n \"labore_d8\": -89861142\n }\n },\n \"transactionReference\": \"\",\n \"transactionInformation\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"categoryId\": \"std:4-AW-\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"dateModified\": \"\",\n \"id\": \"\",\n \"longDescription\": \"\",\n \"notes\": \"\",\n \"shortDescription\": \"\",\n \"status\": \"posted\",\n \"accountId\": \"\",\n \"dateCreated\": \"\",\n \"valueDate\": \"\",\n \"providerId\": \"\",\n \"counterpartyId\": \"\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.tnOAx\"\n },\n \"splits\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"std:O-w--shP-h-\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"cus:--cJzC-\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n }\n ],\n \"transactionCode\": {\n \"code\": \"\",\n \"subCode\": \"\"\n },\n \"proprietaryTransactionCode\": {\n \"code\": \"\",\n \"issuer\": \"\"\n },\n \"balance\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"balanceType\": \"\",\n \"statementReference\": \"\",\n \"merchantName\": \"\",\n \"merchantCategoryCode\": \"\",\n \"cardInstrument\": {\n \"name\": \"\",\n \"pan\": \"\",\n \"cardSchemeName\": \"VISA\",\n \"authorisationType\": \"thU\"\n },\n \"creditorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"creditorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"Excepteur8ef\": \"do ut elit ullamco fugiat\",\n \"consectetur_b58\": -57091973.988453984\n }\n },\n \"debtorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"debtorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"cupidatat5\": -85758923,\n \"laboris__3f\": false\n }\n },\n \"transactionReference\": \"\",\n \"transactionInformation\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-56578079-8c64-4bd1-b6a0-57a63b9e1fbe" }, { "id": "0346a5c2-39bd-4117-a00e-db5341afefa3", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&categoryId=&accountId=&accountIds=,&projectId=&projectIds=,&creditDebitIndicator=credit&hasProject=&onlyCount=false&contains=&hasEnhancedCategory=&counterpartyIds=,&counterpartyIdsV2=,&counterpartiesVersion=v2&enhancedCategories=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions/notes by", "key": "text", "value": "" }, { "description": "The category id to filter transactions by", "key": "categoryId", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "The project id to filter transactions by", "key": "projectId", "value": "" }, { "description": "The project ids to filter transactions by", "key": "projectIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Filter on whether transaction has an attached project", "key": "hasProject", "value": "" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" }, { "description": "Filter on the beginning of words of a transaction's clean description or beginning of transaction amount", "key": "contains", "value": "" }, { "description": "A property to check exists within a transaction", "key": "hasEnhancedCategory", "value": "" }, { "description": "Filter on the transaction's counterparty Id", "key": "counterpartyIds", "value": "," }, { "description": "Filter on the transaction's counterparty Id (Deprecated)", "key": "counterpartyIdsV2", "value": "," }, { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" }, { "description": "An enhanced category to filter transactions by in the form of ${categoryField}:${categoryValue}", "key": "enhancedCategories", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0346a5c2-39bd-4117-a00e-db5341afefa3" }, { "id": "5958f183-c8cf-4fd5-ae65-c94b6e0dd5a6", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&categoryId=&accountId=&accountIds=,&projectId=&projectIds=,&creditDebitIndicator=credit&hasProject=&onlyCount=false&contains=&hasEnhancedCategory=&counterpartyIds=,&counterpartyIdsV2=,&counterpartiesVersion=v2&enhancedCategories=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions/notes by", "key": "text", "value": "" }, { "description": "The category id to filter transactions by", "key": "categoryId", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "The project id to filter transactions by", "key": "projectId", "value": "" }, { "description": "The project ids to filter transactions by", "key": "projectIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Filter on whether transaction has an attached project", "key": "hasProject", "value": "" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" }, { "description": "Filter on the beginning of words of a transaction's clean description or beginning of transaction amount", "key": "contains", "value": "" }, { "description": "A property to check exists within a transaction", "key": "hasEnhancedCategory", "value": "" }, { "description": "Filter on the transaction's counterparty Id", "key": "counterpartyIds", "value": "," }, { "description": "Filter on the transaction's counterparty Id (Deprecated)", "key": "counterpartyIdsV2", "value": "," }, { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" }, { "description": "An enhanced category to filter transactions by in the form of ${categoryField}:${categoryValue}", "key": "enhancedCategories", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5958f183-c8cf-4fd5-ae65-c94b6e0dd5a6" }, { "id": "aa4562d8-d804-49f4-9717-bc2767154b0b", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions?ids=,&limit=&offset=&startDate=&endDate=&startDateModified=&endDateModified=&text=&categoryId=&accountId=&accountIds=,&projectId=&projectIds=,&creditDebitIndicator=credit&hasProject=&onlyCount=false&contains=&hasEnhancedCategory=&counterpartyIds=,&counterpartyIdsV2=,&counterpartiesVersion=v2&enhancedCategories=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Filter on the transaction's Ids (maximum allowed 50)", "key": "ids", "value": "," }, { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The earliest date to receive transactions from (inclusive)", "key": "startDate", "value": "" }, { "description": "The latest date to receive transactions from (inclusive)", "key": "endDate", "value": "" }, { "description": "The earliest date the transactions were modified (inclusive)", "key": "startDateModified", "value": "" }, { "description": "The latest date the transactions were modified (inclusive)", "key": "endDateModified", "value": "" }, { "description": "The text to filter transactions descriptions/notes by", "key": "text", "value": "" }, { "description": "The category id to filter transactions by", "key": "categoryId", "value": "" }, { "description": "The account id to filter transactions by", "key": "accountId", "value": "" }, { "description": "The account ids to filter transactions by", "key": "accountIds", "value": "," }, { "description": "The project id to filter transactions by", "key": "projectId", "value": "" }, { "description": "The project ids to filter transactions by", "key": "projectIds", "value": "," }, { "description": "Filter transactions depending on whether they are credit or debit transactions", "key": "creditDebitIndicator", "value": "credit" }, { "description": "Filter on whether transaction has an attached project", "key": "hasProject", "value": "" }, { "description": "Ensures ONLY the count of transactions is returned in the meta object", "key": "onlyCount", "value": "false" }, { "description": "Filter on the beginning of words of a transaction's clean description or beginning of transaction amount", "key": "contains", "value": "" }, { "description": "A property to check exists within a transaction", "key": "hasEnhancedCategory", "value": "" }, { "description": "Filter on the transaction's counterparty Id", "key": "counterpartyIds", "value": "," }, { "description": "Filter on the transaction's counterparty Id (Deprecated)", "key": "counterpartyIdsV2", "value": "," }, { "description": "Counterparties version", "key": "counterpartiesVersion", "value": "v2" }, { "description": "An enhanced category to filter transactions by in the form of ${categoryField}:${categoryValue}", "key": "enhancedCategories", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-aa4562d8-d804-49f4-9717-bc2767154b0b" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5f09b409-0ffe-44d7-aa41-257bd2246e8d" }, { "name": "Create a single transaction for a user", "id": "8c326771-fde3-40ea-aec4-2a75d229462a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:----m\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.XFD\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] }, "description": "Requires **transactions:read:all** and **transactions:write:all** scopes." }, "response": [ { "id": "e84c0ddb-1f09-4c9d-9171-2277979a823f", "name": "Successful Transaction Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:----m\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.XFD\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"categoryId\": \"cus:-Rs------\",\n \"categoryIdConfirmed\": \"\",\n \"date\": \"\",\n \"dateModified\": \"\",\n \"id\": \"\",\n \"longDescription\": \"\",\n \"notes\": \"\",\n \"shortDescription\": \"\",\n \"status\": \"posted\",\n \"accountId\": \"\",\n \"dateCreated\": \"\",\n \"valueDate\": \"\",\n \"providerId\": \"\",\n \"counterpartyId\": \"\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.tGvac\"\n },\n \"splits\": [\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"cus:-ni-u---g6-\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n },\n {\n \"amount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"categoryId\": \"std:I-QYR5n\",\n \"description\": \"\",\n \"id\": \"\",\n \"projectId\": \"\"\n }\n ],\n \"transactionCode\": {\n \"code\": \"\",\n \"subCode\": \"\"\n },\n \"proprietaryTransactionCode\": {\n \"code\": \"\",\n \"issuer\": \"\"\n },\n \"balance\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"balanceType\": \"\",\n \"statementReference\": \"\",\n \"merchantName\": \"\",\n \"merchantCategoryCode\": \"\",\n \"cardInstrument\": {\n \"name\": \"\",\n \"pan\": \"\",\n \"cardSchemeName\": \"VISA\",\n \"authorisationType\": \"Ugbwf\"\n },\n \"creditorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"creditorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"inb\": false,\n \"dolor_2b6\": \"tempor do ea \",\n \"et_9\": \"eiusmod labore commodo\"\n }\n },\n \"debtorAccount\": {\n \"name\": \"\",\n \"sortCode\": \"\",\n \"accountNumber\": \"\",\n \"iban\": \"\",\n \"pan\": \"\"\n },\n \"debtorAgent\": {\n \"name\": \"\",\n \"postalAddress\": {\n \"ina1\": \"elit consequat cup\",\n \"nisi_16_\": 19179203\n }\n },\n \"transactionReference\": \"\",\n \"transactionInformation\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e84c0ddb-1f09-4c9d-9171-2277979a823f" }, { "id": "329bb224-667b-4a68-a044-60521cc62370", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:----m\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.XFD\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-329bb224-667b-4a68-a044-60521cc62370" }, { "id": "11c0e844-cd6b-4a3a-ac14-1d7c4d904c43", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:----m\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.XFD\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-11c0e844-cd6b-4a3a-ac14-1d7c4d904c43" }, { "id": "9adccb9d-5a9a-47cc-8731-e7ca05bdbfad", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:----m\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"posted\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"income.XFD\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9adccb9d-5a9a-47cc-8731-e7ca05bdbfad" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8c326771-fde3-40ea-aec4-2a75d229462a" } ], "id": "452b7c89-8fad-44ed-9a36-b183e1cc4892", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-452b7c89-8fad-44ed-9a36-b183e1cc4892" }, { "name": "transactions-collection", "item": [ { "name": "Create multiple transactions for a user", "id": "769ca388-a9ae-4cf4-917b-764515a07b61", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:-wnD----\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.LX\"\n }\n },\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:3Bw-\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.DO-\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions-collection?categorise=", "host": [ "{{baseUrl}}" ], "path": [ "transactions-collection" ], "query": [ { "description": "Enable categorisation of transactions", "key": "categorise", "value": "" } ] }, "description": "Requires **transactions:read:all** and **transactions:write:all** scopes. A maximum of 50 transactions is imposed." }, "response": [ { "id": "5f5519b3-5835-475d-8836-c421ed8855a1", "name": "Successful Transaction Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:-wnD----\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.LX\"\n }\n },\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:3Bw-\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.DO-\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions-collection?categorise=", "host": [ "{{baseUrl}}" ], "path": [ "transactions-collection" ], "query": [ { "description": "Enable categorisation of transactions", "key": "categorise", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-5f5519b3-5835-475d-8836-c421ed8855a1" }, { "id": "74cddcee-a485-443d-9ea6-736a4e5126a4", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:-wnD----\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.LX\"\n }\n },\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:3Bw-\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.DO-\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions-collection?categorise=", "host": [ "{{baseUrl}}" ], "path": [ "transactions-collection" ], "query": [ { "description": "Enable categorisation of transactions", "key": "categorise", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-74cddcee-a485-443d-9ea6-736a4e5126a4" }, { "id": "141a86d2-2860-4831-bf32-6ec0e61a4ecd", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:-wnD----\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.LX\"\n }\n },\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:3Bw-\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.DO-\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions-collection?categorise=", "host": [ "{{baseUrl}}" ], "path": [ "transactions-collection" ], "query": [ { "description": "Enable categorisation of transactions", "key": "categorise", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-141a86d2-2860-4831-bf32-6ec0e61a4ecd" }, { "id": "1bcc4a4e-9d56-4023-be2b-304fe550bb3f", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:-wnD----\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.LX\"\n }\n },\n {\n \"accountId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"categoryId\": \"std:3Bw-\",\n \"date\": \"\",\n \"longDescription\": \"\",\n \"categoryIdConfirmed\": \"\",\n \"shortDescription\": \"\",\n \"notes\": \"\",\n \"status\": \"pending\",\n \"projectId\": \"\",\n \"enhancedCategories\": {\n \"uk-tax-hmrc\": \"expenditure.DO-\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transactions-collection?categorise=", "host": [ "{{baseUrl}}" ], "path": [ "transactions-collection" ], "query": [ { "description": "Enable categorisation of transactions", "key": "categorise", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1bcc4a4e-9d56-4023-be2b-304fe550bb3f" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-769ca388-a9ae-4cf4-917b-764515a07b61" } ], "id": "7cd6e255-49d1-4571-a643-4114518303cf", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7cd6e255-49d1-4571-a643-4114518303cf" }, { "name": "categories", "item": [ { "name": "{categoryId}", "item": [ { "name": "Retrieve a single category", "id": "7dfd25f4-0114-4218-ac2f-b345fe89b64b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:categoryId?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":categoryId" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ], "variable": [ { "id": "be29710e-0313-41d2-bae3-ad6a9dbb4af3", "key": "categoryId", "value": "std:-h-", "description": "(Required) The Category Id" } ] }, "description": "Requires **categories:read** scope." }, "response": [ { "id": "4d91e1a6-6e36-446d-9923-93507dd50199", "name": "Successful Category Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/categories/:categoryId?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":categoryId" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ], "variable": [ { "key": "categoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"categoryId\": \"cus:----W--\",\n \"group\": \"\",\n \"name\": \"\",\n \"key\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4d91e1a6-6e36-446d-9923-93507dd50199" }, { "id": "01dc9679-2e86-4b6e-8f54-944a9031d46a", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/categories/:categoryId?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":categoryId" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ], "variable": [ { "key": "categoryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-01dc9679-2e86-4b6e-8f54-944a9031d46a" }, { "id": "a9eeae08-7c73-4d34-88eb-09b955566169", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/categories/:categoryId?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":categoryId" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ], "variable": [ { "key": "categoryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a9eeae08-7c73-4d34-88eb-09b955566169" }, { "id": "2646752b-2ede-4593-a064-db93cd893929", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/categories/:categoryId?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":categoryId" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ], "variable": [ { "key": "categoryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2646752b-2ede-4593-a064-db93cd893929" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7dfd25f4-0114-4218-ac2f-b345fe89b64b" } ], "id": "cb61820d-22b5-44c2-b5f7-3dd2eae2c318", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-cb61820d-22b5-44c2-b5f7-3dd2eae2c318" }, { "name": "Retrieve all categories for a user", "id": "1a330515-4e85-4772-aa77-877ae8751c85", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories?limit=&offset=&type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ] }, "description": "Requires **categories:read** scope." }, "response": [ { "id": "ac1fee6d-8486-4b6e-8a42-72f468d5c4ec", "name": "Successful Categories Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/categories?limit=&offset=&type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"categoryId\": \"std:-B---2-\",\n \"group\": \"\",\n \"name\": \"\",\n \"key\": \"\"\n },\n {\n \"categoryId\": \"cus:--G_-C\",\n \"group\": \"\",\n \"name\": \"\",\n \"key\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ac1fee6d-8486-4b6e-8a42-72f468d5c4ec" }, { "id": "3f51f87f-188a-4c5f-9a7a-4cbb542ae99f", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/categories?limit=&offset=&type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3f51f87f-188a-4c5f-9a7a-4cbb542ae99f" }, { "id": "677d3994-1bd1-4872-88a9-4209380e6e02", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/categories?limit=&offset=&type=personal", "host": [ "{{baseUrl}}" ], "path": [ "categories" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" }, { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-677d3994-1bd1-4872-88a9-4209380e6e02" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1a330515-4e85-4772-aa77-877ae8751c85" }, { "name": "Add a new custom category for a user", "id": "77f2543d-46ac-4be6-88e5-e2c8d2e3e0a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"group\": \"group:533351031\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] }, "description": "Requires **categories:write** scope." }, "response": [ { "id": "6d03e832-2e49-42a1-9d92-32ed2e8b94aa", "name": "Successful Category Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"group\": \"group:533351031\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"categoryId\": \"cus:----W--\",\n \"group\": \"\",\n \"name\": \"\",\n \"key\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6d03e832-2e49-42a1-9d92-32ed2e8b94aa" }, { "id": "3161f828-283b-4501-9d61-615325819eb9", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"group\": \"group:533351031\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3161f828-283b-4501-9d61-615325819eb9" }, { "id": "787945d5-cf51-4a3f-9b4b-6297ec8c8113", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"group\": \"group:533351031\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-787945d5-cf51-4a3f-9b4b-6297ec8c8113" }, { "id": "e7d88cd0-cc79-4fac-b563-8f29adc33bb8", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"group\": \"group:533351031\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e7d88cd0-cc79-4fac-b563-8f29adc33bb8" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-77f2543d-46ac-4be6-88e5-e2c8d2e3e0a7" } ], "id": "e646a43a-f91f-4a30-824c-e4f77f1b8f35", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e646a43a-f91f-4a30-824c-e4f77f1b8f35" }, { "name": "category-groups", "item": [ { "name": "Retrieve all category groups for a user", "id": "1a2add82-ad48-42f8-a315-d6a49e662f0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/category-groups?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "category-groups" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ] }, "description": "Requires **categories:read** scope." }, "response": [ { "id": "23e8e8e9-e36d-41da-ac61-8d95fc2d8b56", "name": "Successful Category Groups Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/category-groups?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "category-groups" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"key\": \"\"\n },\n {\n \"id\": \"\",\n \"key\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-23e8e8e9-e36d-41da-ac61-8d95fc2d8b56" }, { "id": "ab0b812b-4a15-4406-8c67-1e7db217dacb", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/category-groups?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "category-groups" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ab0b812b-4a15-4406-8c67-1e7db217dacb" }, { "id": "24f35d01-9fd8-4d0c-ab09-40fc740e7b9c", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/category-groups?type=personal", "host": [ "{{baseUrl}}" ], "path": [ "category-groups" ], "query": [ { "description": "The types of categories to be returned", "key": "type", "value": "personal" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-24f35d01-9fd8-4d0c-ab09-40fc740e7b9c" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1a2add82-ad48-42f8-a315-d6a49e662f0d" } ], "id": "ffbe76d0-9b97-4c09-852a-ababbfb4c865", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ffbe76d0-9b97-4c09-852a-ababbfb4c865" }, { "name": "categorise-transactions", "item": [ { "name": "Categorises a given set of transactions", "id": "976044a4-b6d7-43e1-86ed-fe6304e8a26e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n },\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n }\n ],\n \"accountType\": \"cash\",\n \"accountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categorise-transactions", "host": [ "{{baseUrl}}" ], "path": [ "categorise-transactions" ] }, "description": "Requires **categorisation** scope. A maximum of 200 transactions is imposed." }, "response": [ { "id": "af99b5a9-8298-44fb-b232-0bdbe55cb4f6", "name": "Successful Categorisation Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n },\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n }\n ],\n \"accountType\": \"cash\",\n \"accountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categorise-transactions", "host": [ "{{baseUrl}}" ], "path": [ "categorise-transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"accountId\": \"\",\n \"accountType\": \"cash\",\n \"transactions\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"categoryId\": \"std:--J--H--t-6\",\n \"counterpartyId\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n },\n {\n \"id\": \"\",\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"categoryId\": \"std:d---NE-\",\n \"counterpartyId\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n }\n ],\n \"failedCategorisationIds\": [\n \"\",\n \"\"\n ]\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-af99b5a9-8298-44fb-b232-0bdbe55cb4f6" }, { "id": "028f2c0b-b0fb-4b80-9193-ba8099fd1613", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n },\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n }\n ],\n \"accountType\": \"cash\",\n \"accountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categorise-transactions", "host": [ "{{baseUrl}}" ], "path": [ "categorise-transactions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-028f2c0b-b0fb-4b80-9193-ba8099fd1613" }, { "id": "033e3fdf-ba30-4b51-bb66-018babd68338", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n },\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n }\n ],\n \"accountType\": \"cash\",\n \"accountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categorise-transactions", "host": [ "{{baseUrl}}" ], "path": [ "categorise-transactions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-033e3fdf-ba30-4b51-bb66-018babd68338" }, { "id": "d5216e12-ba18-4421-961e-b888baa61950", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n },\n {\n \"description\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"date\": \"\",\n \"id\": \"\",\n \"proprietaryTransactionCode\": \"\",\n \"merchantCategoryCode\": \"\"\n }\n ],\n \"accountType\": \"cash\",\n \"accountId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/categorise-transactions", "host": [ "{{baseUrl}}" ], "path": [ "categorise-transactions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d5216e12-ba18-4421-961e-b888baa61950" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-976044a4-b6d7-43e1-86ed-fe6304e8a26e" } ], "id": "e3bb9c07-9124-4a1f-beac-2d447cf217f3", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e3bb9c07-9124-4a1f-beac-2d447cf217f3" }, { "name": "regular-transactions", "item": [ { "name": "{accountId}", "item": [ { "name": "detect", "item": [ { "name": "Detect regular transactions", "id": "9f3befd7-8f78-4951-8e1d-d60d949f4e7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/regular-transactions/:accountId/detect", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions", ":accountId", "detect" ], "variable": [ { "id": "0e3267e5-0a51-4caf-b025-542aff1f71a6", "key": "accountId", "value": "", "description": "(Required) The Account Id" } ] }, "description": "Requires **regular_transactions:write**, **regular_transactions:read**, **accounts:read** and **transactions:read:all** scopes." }, "response": [ { "id": "8f5af6cc-fb22-4514-833e-cd79a6b7b24a", "name": "Successful Regular Transactions Response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/regular-transactions/:accountId/detect", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions", ":accountId", "detect" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"seriesId\": \"\",\n \"accountId\": \"\",\n \"type\": \"payment\",\n \"cleanedDescription\": \"\",\n \"frequency\": \"yearly\",\n \"numTxMatchedInSeries\": \"\",\n \"lastDate\": \"\",\n \"predictedDate\": \"\",\n \"predictedAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"transactions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"counterpartyId\": \"\",\n \"gapLengthInFreqUnits\": \"\",\n \"dateAnomaliesCount\": \"\",\n \"numReturnedTxs\": \"\",\n \"predictedDateEarliest\": \"\",\n \"predictedDateLatest\": \"\",\n \"predictedTxLateOrNotDetected\": \"\",\n \"predictedAmountLower\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictedAmountUpper\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictedCategoryId\": \"cus:-oSe--A--\"\n },\n {\n \"seriesId\": \"\",\n \"accountId\": \"\",\n \"type\": \"payment\",\n \"cleanedDescription\": \"\",\n \"frequency\": \"yearly\",\n \"numTxMatchedInSeries\": \"\",\n \"lastDate\": \"\",\n \"predictedDate\": \"\",\n \"predictedAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"transactions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"counterpartyId\": \"\",\n \"gapLengthInFreqUnits\": \"\",\n \"dateAnomaliesCount\": \"\",\n \"numReturnedTxs\": \"\",\n \"predictedDateEarliest\": \"\",\n \"predictedDateLatest\": \"\",\n \"predictedTxLateOrNotDetected\": \"\",\n \"predictedAmountLower\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictedAmountUpper\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictedCategoryId\": \"cus:vu--\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8f5af6cc-fb22-4514-833e-cd79a6b7b24a" }, { "id": "b1143bb1-0485-43c0-b71f-fd093a3a630f", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/regular-transactions/:accountId/detect", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions", ":accountId", "detect" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b1143bb1-0485-43c0-b71f-fd093a3a630f" }, { "id": "0d96d4b5-2928-4010-90c7-ef3b972c38b7", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/regular-transactions/:accountId/detect", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions", ":accountId", "detect" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0d96d4b5-2928-4010-90c7-ef3b972c38b7" }, { "id": "622f31f2-94a0-4cab-9edd-8834603e8ff3", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/regular-transactions/:accountId/detect", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions", ":accountId", "detect" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-622f31f2-94a0-4cab-9edd-8834603e8ff3" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9f3befd7-8f78-4951-8e1d-d60d949f4e7c" } ], "id": "96ef4189-3774-40f0-ad28-9c45a92074e6", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-96ef4189-3774-40f0-ad28-9c45a92074e6" } ], "id": "f835f728-349c-4eb1-b997-8f9d4fe7cd10", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f835f728-349c-4eb1-b997-8f9d4fe7cd10" }, { "name": "Retrieve regular transactions", "id": "fc4179b1-e22b-46a8-8e84-0ec74fa746f9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/regular-transactions?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions" ], "query": [ { "description": "The Account Id", "key": "accountId", "value": "" } ] }, "description": "Requires **regular_transactions:read**, **accounts:read** and **transactions:read:all** scopes." }, "response": [ { "id": "750322dd-53b6-4afd-aa69-f277ca1e733b", "name": "Successful Regular Transactions Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/regular-transactions?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions" ], "query": [ { "description": "The Account Id", "key": "accountId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"seriesId\": \"\",\n \"accountId\": \"\",\n \"type\": \"payment\",\n \"cleanedDescription\": \"\",\n \"frequency\": \"yearly\",\n \"numTxMatchedInSeries\": \"\",\n \"lastDate\": \"\",\n \"predictedDate\": \"\",\n \"predictedAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"transactions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"counterpartyId\": \"\",\n \"gapLengthInFreqUnits\": \"\",\n \"dateAnomaliesCount\": \"\",\n \"numReturnedTxs\": \"\",\n \"predictedDateEarliest\": \"\",\n \"predictedDateLatest\": \"\",\n \"predictedTxLateOrNotDetected\": \"\",\n \"predictedAmountLower\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictedAmountUpper\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictedCategoryId\": \"cus:-oSe--A--\"\n },\n {\n \"seriesId\": \"\",\n \"accountId\": \"\",\n \"type\": \"payment\",\n \"cleanedDescription\": \"\",\n \"frequency\": \"yearly\",\n \"numTxMatchedInSeries\": \"\",\n \"lastDate\": \"\",\n \"predictedDate\": \"\",\n \"predictedAmount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"transactions\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"counterpartyId\": \"\",\n \"gapLengthInFreqUnits\": \"\",\n \"dateAnomaliesCount\": \"\",\n \"numReturnedTxs\": \"\",\n \"predictedDateEarliest\": \"\",\n \"predictedDateLatest\": \"\",\n \"predictedTxLateOrNotDetected\": \"\",\n \"predictedAmountLower\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictedAmountUpper\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"predictedCategoryId\": \"cus:vu--\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-750322dd-53b6-4afd-aa69-f277ca1e733b" }, { "id": "82bdf6c4-8019-4098-9c09-115b932b6a34", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/regular-transactions?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions" ], "query": [ { "description": "The Account Id", "key": "accountId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-82bdf6c4-8019-4098-9c09-115b932b6a34" }, { "id": "21924cb2-6b4c-4fa2-912e-0310b7720f00", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/regular-transactions?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions" ], "query": [ { "description": "The Account Id", "key": "accountId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-21924cb2-6b4c-4fa2-912e-0310b7720f00" }, { "id": "c3b417e1-7c65-40d1-b443-66ff955155ca", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/regular-transactions?accountId=", "host": [ "{{baseUrl}}" ], "path": [ "regular-transactions" ], "query": [ { "description": "The Account Id", "key": "accountId", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c3b417e1-7c65-40d1-b443-66ff955155ca" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fc4179b1-e22b-46a8-8e84-0ec74fa746f9" } ], "id": "537870d0-1e29-4411-808d-a0e523e806ad", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-537870d0-1e29-4411-808d-a0e523e806ad" }, { "name": "rental-records", "item": [ { "name": "{rentalId}", "item": [ { "name": "Delete a rental record", "id": "787d2f17-0fda-4997-99c0-881821607519", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rental-records/:rentalId", "host": [ "{{baseUrl}}" ], "path": [ "rental-records", ":rentalId" ], "variable": [ { "id": "ea00b918-7f96-4328-9cab-5896deab1594", "key": "rentalId", "value": "", "description": "(Required) The rental record ID" } ] }, "description": "Requires **rental_records:write** scope." }, "response": [ { "id": "d39ae2a2-2505-4f8c-9819-00457ef82ec8", "name": "Successful Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rental-records/:rentalId", "host": [ "{{baseUrl}}" ], "path": [ "rental-records", ":rentalId" ], "variable": [ { "key": "rentalId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d39ae2a2-2505-4f8c-9819-00457ef82ec8" }, { "id": "cd2661a4-7509-40eb-a58e-8e6275c70902", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rental-records/:rentalId", "host": [ "{{baseUrl}}" ], "path": [ "rental-records", ":rentalId" ], "variable": [ { "key": "rentalId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-cd2661a4-7509-40eb-a58e-8e6275c70902" }, { "id": "457a7c85-0ada-48d4-8a94-9af18654484a", "name": "Unsuccessful Response - Forbidden", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rental-records/:rentalId", "host": [ "{{baseUrl}}" ], "path": [ "rental-records", ":rentalId" ], "variable": [ { "key": "rentalId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-457a7c85-0ada-48d4-8a94-9af18654484a" }, { "id": "d4b6d4a0-008b-48ac-a047-ead602bc5cd0", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rental-records/:rentalId", "host": [ "{{baseUrl}}" ], "path": [ "rental-records", ":rentalId" ], "variable": [ { "key": "rentalId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d4b6d4a0-008b-48ac-a047-ead602bc5cd0" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-787d2f17-0fda-4997-99c0-881821607519" } ], "id": "18e1176b-5d5c-4337-8bae-13a6a8867a19", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-18e1176b-5d5c-4337-8bae-13a6a8867a19" }, { "name": "Retrieve rental recognition record", "id": "6fb4e173-e273-4f43-8a2f-b66f8c4ef4fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rental-records", "host": [ "{{baseUrl}}" ], "path": [ "rental-records" ] }, "description": "Requires **rental_records:read** scope. Please note that a user will only have one rental recognition record. The rental record returned will be for the authenticated user." }, "response": [ { "id": "6ccde822-e23f-4819-8d7d-ef7adbea1b9b", "name": "Successful Rental Record Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rental-records", "host": [ "{{baseUrl}}" ], "path": [ "rental-records" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthdate\": \"3211-65-6\",\n \"addressLine1\": \"\",\n \"postalCode\": \"htWmsR\",\n \"tenancyStartDate\": \"8252-1-1\",\n \"rentalAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"rentalFrequency\": \"fortnightly\",\n \"seriesId\": \"\",\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"title\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"addressLine4\": \"\",\n \"lastSubmittedDate\": \"\",\n \"consentApprovedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthdate\": \"7402-2-7\",\n \"addressLine1\": \"\",\n \"postalCode\": \"u3\",\n \"tenancyStartDate\": \"0490-49-57\",\n \"rentalAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"rentalFrequency\": \"monthly\",\n \"seriesId\": \"\",\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"title\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"addressLine4\": \"\",\n \"lastSubmittedDate\": \"\",\n \"consentApprovedAt\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6ccde822-e23f-4819-8d7d-ef7adbea1b9b" }, { "id": "d010ed68-053e-4674-9237-2162a03426f8", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rental-records", "host": [ "{{baseUrl}}" ], "path": [ "rental-records" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d010ed68-053e-4674-9237-2162a03426f8" }, { "id": "9163e4e9-38ff-48fb-a56b-5f7882dda541", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rental-records", "host": [ "{{baseUrl}}" ], "path": [ "rental-records" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9163e4e9-38ff-48fb-a56b-5f7882dda541" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6fb4e173-e273-4f43-8a2f-b66f8c4ef4fe" }, { "name": "Create a rental recognition record for user", "id": "02bc15cd-b5d9-4ddf-8a99-aa486ad09e53", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthdate\": \"6305-2-30\",\n \"addressLine1\": \"\",\n \"postalCode\": \"hgCGZXCY\",\n \"tenancyStartDate\": \"5912-94-90\",\n \"rentalAmount\": {\n \"value\": \"\"\n },\n \"rentalFrequency\": \"monthly\",\n \"seriesId\": \"\",\n \"title\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"addressLine4\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rental-records", "host": [ "{{baseUrl}}" ], "path": [ "rental-records" ] }, "description": "Requires **rental_records:write** scope. Please note that a user will only have one rental recognition record. The rental record created will be for the authenticated user." }, "response": [ { "id": "4de66d38-fc74-4877-82e3-cc000c477a91", "name": "Successful Rental Record Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthdate\": \"6305-2-30\",\n \"addressLine1\": \"\",\n \"postalCode\": \"hgCGZXCY\",\n \"tenancyStartDate\": \"5912-94-90\",\n \"rentalAmount\": {\n \"value\": \"\"\n },\n \"rentalFrequency\": \"monthly\",\n \"seriesId\": \"\",\n \"title\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"addressLine4\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rental-records", "host": [ "{{baseUrl}}" ], "path": [ "rental-records" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"userId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthdate\": \"6051-4-21\",\n \"addressLine1\": \"\",\n \"postalCode\": \"FAqTA\",\n \"tenancyStartDate\": \"1081-06-5\",\n \"rentalAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n },\n \"rentalFrequency\": \"monthly\",\n \"seriesId\": \"\",\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"title\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"addressLine4\": \"\",\n \"lastSubmittedDate\": \"\",\n \"consentApprovedAt\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4de66d38-fc74-4877-82e3-cc000c477a91" }, { "id": "049c1068-dff3-4ea9-a70e-d2736da3acfa", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthdate\": \"6305-2-30\",\n \"addressLine1\": \"\",\n \"postalCode\": \"hgCGZXCY\",\n \"tenancyStartDate\": \"5912-94-90\",\n \"rentalAmount\": {\n \"value\": \"\"\n },\n \"rentalFrequency\": \"monthly\",\n \"seriesId\": \"\",\n \"title\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"addressLine4\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rental-records", "host": [ "{{baseUrl}}" ], "path": [ "rental-records" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-049c1068-dff3-4ea9-a70e-d2736da3acfa" }, { "id": "1cdb0620-dd01-4669-a090-4b0d654761d3", "name": "Unsuccessful Response - Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"birthdate\": \"6305-2-30\",\n \"addressLine1\": \"\",\n \"postalCode\": \"hgCGZXCY\",\n \"tenancyStartDate\": \"5912-94-90\",\n \"rentalAmount\": {\n \"value\": \"\"\n },\n \"rentalFrequency\": \"monthly\",\n \"seriesId\": \"\",\n \"title\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"addressLine4\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rental-records", "host": [ "{{baseUrl}}" ], "path": [ "rental-records" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1cdb0620-dd01-4669-a090-4b0d654761d3" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-02bc15cd-b5d9-4ddf-8a99-aa486ad09e53" } ], "id": "9b7c64fe-9967-41e9-a2c7-d56c2dec0092", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9b7c64fe-9967-41e9-a2c7-d56c2dec0092" }, { "name": "spending-analysis", "item": [ { "name": "Retrieve spending analysis by categories, projects and accounts", "id": "b3f58c86-2a71-4d78-af2f-77c924941850", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dates\": [\n {\n \"name\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n }\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-analysis", "host": [ "{{baseUrl}}" ], "path": [ "spending-analysis" ] }, "description": "Defaults to all categories and accounts if none specified.\n
The categories field in the response has a breakdown of the total by categories for the given periods. You can expect to also receive the breakdown for income and transfer categories.\n
The 'total' field in the response calculates the total outgoing expenditure for the given periods. This calculation do not include income and transfers.\n
Categories under the transfer group are the only ones that can appear twice showing income and expenditure separately\n
Requires **spending_analysis:read** scope." }, "response": [ { "id": "c2a8e794-d23e-4063-80b9-c96e6944c5d7", "name": "Successful Spending Analysis Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dates\": [\n {\n \"name\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n }\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-analysis", "host": [ "{{baseUrl}}" ], "path": [ "spending-analysis" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"categories\": [\n {\n \"categoryId\": \"\",\n \"categoryGroup\": \"\",\n \"in_12\": 99121758\n },\n {\n \"categoryId\": \"\",\n \"categoryGroup\": \"\",\n \"cupidatatf\": 2719302.0677121878,\n \"culpa_b\": \"ex dolor sit\",\n \"veniam__05\": false\n }\n ],\n \"total\": {\n \"voluptate5f\": true\n }\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c2a8e794-d23e-4063-80b9-c96e6944c5d7" }, { "id": "442e647a-4b1d-4954-a7ea-b0bcbea4fb20", "name": "Unsuccessful Response - Bad request - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dates\": [\n {\n \"name\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n }\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-analysis", "host": [ "{{baseUrl}}" ], "path": [ "spending-analysis" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-442e647a-4b1d-4954-a7ea-b0bcbea4fb20" }, { "id": "2b6079b8-a934-464d-8840-8b2ca3196d81", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dates\": [\n {\n \"name\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n }\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-analysis", "host": [ "{{baseUrl}}" ], "path": [ "spending-analysis" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2b6079b8-a934-464d-8840-8b2ca3196d81" }, { "id": "27d55aa6-70e4-4876-b992-f05072dddc15", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dates\": [\n {\n \"name\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n }\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"categoryIds\": [\n \"\",\n \"\"\n ],\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-analysis", "host": [ "{{baseUrl}}" ], "path": [ "spending-analysis" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-27d55aa6-70e4-4876-b992-f05072dddc15" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-b3f58c86-2a71-4d78-af2f-77c924941850" } ], "id": "fb3c5faf-76bd-4ed0-b475-1f76b115644a", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fb3c5faf-76bd-4ed0-b475-1f76b115644a" }, { "name": "spending-goals", "item": [ { "name": "{goalId}", "item": [ { "name": "Retrieve a single spending goal", "id": "08e3555b-6511-4098-a85e-28122c2393cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "id": "8715a66b-769b-4432-bc51-8eebe6b940d2", "key": "goalId", "value": "", "description": "(Required) The Goal Id" } ] }, "description": "Requires **spending_goals:read** scope." }, "response": [ { "id": "4a64821a-50b0-4acc-b448-fce696619478", "name": "Successful Spending Goal Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"categoryId\": \"cus:nv-t6\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"periodStart\": \"25\",\n \"periodType\": \"annual\",\n \"spending\": [\n {\n \"date\": \"\",\n \"spent\": \"\"\n },\n {\n \"date\": \"\",\n \"spent\": \"\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4a64821a-50b0-4acc-b448-fce696619478" }, { "id": "32b39420-6942-494f-8f9e-f05cbc6231dc", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-32b39420-6942-494f-8f9e-f05cbc6231dc" }, { "id": "a006c044-123d-41aa-bf0d-5324bd6f2eb0", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a006c044-123d-41aa-bf0d-5324bd6f2eb0" }, { "id": "c091bb60-ada7-4d09-a223-54b55cde10e2", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c091bb60-ada7-4d09-a223-54b55cde10e2" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-08e3555b-6511-4098-a85e-28122c2393cd" }, { "name": "Update a single spending goal", "id": "ef45adfa-32ea-4be1-9c5e-efc3b4b6d703", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "id": "d4d3bcc1-94b2-4bc8-b05f-e648246e5f75", "key": "goalId", "value": "", "description": "(Required) The Goal Id" } ] }, "description": "Requires **spending_goals:read spending_goals:write** scope." }, "response": [ { "id": "9270fb0e-28a3-4772-9561-f4d4f3b83a02", "name": "Successful Spending Goal Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"categoryId\": \"cus:nv-t6\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"periodStart\": \"25\",\n \"periodType\": \"annual\",\n \"spending\": [\n {\n \"date\": \"\",\n \"spent\": \"\"\n },\n {\n \"date\": \"\",\n \"spent\": \"\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9270fb0e-28a3-4772-9561-f4d4f3b83a02" }, { "id": "d96ce4fa-eff0-4019-b37c-9bd455aea81d", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d96ce4fa-eff0-4019-b37c-9bd455aea81d" }, { "id": "bd88baef-cc69-4397-bbde-6e7c997928d9", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bd88baef-cc69-4397-bbde-6e7c997928d9" }, { "id": "e0fd7feb-c83b-47a5-a5eb-ad4d73e84248", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e0fd7feb-c83b-47a5-a5eb-ad4d73e84248" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ef45adfa-32ea-4be1-9c5e-efc3b4b6d703" }, { "name": "Delete a single spending goal", "id": "606ae47a-7117-4caa-bbb6-7acbdcfb65eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "id": "8f27ad3a-f54c-4ea3-b610-c5be65a79a64", "key": "goalId", "value": "", "description": "(Required) The Goal Id" } ] }, "description": "Requires **spending_goals:write:all** scope." }, "response": [ { "id": "dc8b7892-6f6f-47d2-b107-45cf9cea6b6f", "name": "Successful Spending Goal Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-dc8b7892-6f6f-47d2-b107-45cf9cea6b6f" }, { "id": "9160aacf-80da-42c1-8627-43c5ec77ec73", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9160aacf-80da-42c1-8627-43c5ec77ec73" }, { "id": "07da41dd-d04a-4acd-ac4b-85bf2e53ddb2", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-07da41dd-d04a-4acd-ac4b-85bf2e53ddb2" }, { "id": "bbfb3e50-8e50-4354-b320-50121751ffde", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bbfb3e50-8e50-4354-b320-50121751ffde" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-606ae47a-7117-4caa-bbb6-7acbdcfb65eb" } ], "id": "bd82ebd3-f56c-4171-89b9-a18a311daa58", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bd82ebd3-f56c-4171-89b9-a18a311daa58" }, { "name": "Retrieve all spending goals for a user", "id": "0d896da4-8a09-47cc-8822-198d05fb9c96", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/spending-goals?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] }, "description": "Requires **spending_goals:read** scope." }, "response": [ { "id": "4ef3e414-eb71-4d9c-9610-283f02bc51df", "name": "Successful Spending Goals Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/spending-goals?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"categoryId\": \"cus:-o\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"periodStart\": \"29-10\",\n \"periodType\": \"annual\",\n \"spending\": [\n {\n \"date\": \"\",\n \"spent\": \"\"\n },\n {\n \"date\": \"\",\n \"spent\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"categoryId\": \"cus:6-R-t--\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"periodStart\": \"31-10\",\n \"periodType\": \"monthly\",\n \"spending\": [\n {\n \"date\": \"\",\n \"spent\": \"\"\n },\n {\n \"date\": \"\",\n \"spent\": \"\"\n }\n ]\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4ef3e414-eb71-4d9c-9610-283f02bc51df" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0d896da4-8a09-47cc-8822-198d05fb9c96" }, { "name": "Create a single spending goal for a user", "id": "7525a365-51c2-4360-ae9c-c320adc7a4af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"periodType\": \"annual\",\n \"periodStart\": \"21-11\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals" ] }, "description": "Requires **spending_goals:read** and **spending_goals:write:all** scopes." }, "response": [ { "id": "c06c1a12-2629-4b3d-ab0f-0ef0583545db", "name": "Successful Spending Goal Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"periodType\": \"annual\",\n \"periodStart\": \"21-11\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"dateCreated\": \"\",\n \"categoryId\": \"cus:nv-t6\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"periodStart\": \"25\",\n \"periodType\": \"annual\",\n \"spending\": [\n {\n \"date\": \"\",\n \"spent\": \"\"\n },\n {\n \"date\": \"\",\n \"spent\": \"\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c06c1a12-2629-4b3d-ab0f-0ef0583545db" }, { "id": "1e7e88b6-fba1-4de1-9917-1e1a1a08d277", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"periodType\": \"annual\",\n \"periodStart\": \"21-11\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1e7e88b6-fba1-4de1-9917-1e1a1a08d277" }, { "id": "cdf97661-10ed-4632-9fd9-c7963a25fe3b", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"periodType\": \"annual\",\n \"periodStart\": \"21-11\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-cdf97661-10ed-4632-9fd9-c7963a25fe3b" }, { "id": "90156dc3-bbcf-4d0b-843a-5347fce9cbb8", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"periodType\": \"annual\",\n \"periodStart\": \"21-11\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/spending-goals", "host": [ "{{baseUrl}}" ], "path": [ "spending-goals" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-90156dc3-bbcf-4d0b-843a-5347fce9cbb8" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7525a365-51c2-4360-ae9c-c320adc7a4af" } ], "id": "06d16d6f-6d53-4611-bf46-80da66c9b0d0", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-06d16d6f-6d53-4611-bf46-80da66c9b0d0" }, { "name": "savings-goals", "item": [ { "name": "{goalId}", "item": [ { "name": "Retrieve a single savings goal", "id": "de9d1b9a-9041-4eda-808b-40da82f614c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "id": "908ae813-c83e-4621-8ceb-1f2fea40dae5", "key": "goalId", "value": "", "description": "(Required) The Goal Id" } ] }, "description": "Requires **savings_goals:read** scope." }, "response": [ { "id": "55b9fb94-abe5-46e6-b8e8-0f62cf6f3017", "name": "Successful Spending Goal Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"dateCreated\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"targetDate\": \"\",\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"progressPercentage\": \"\",\n \"progressAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-55b9fb94-abe5-46e6-b8e8-0f62cf6f3017" }, { "id": "ac2d6bea-b1d2-449f-9220-abbf5185b621", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ac2d6bea-b1d2-449f-9220-abbf5185b621" }, { "id": "e033d0f9-6ac0-4be8-b976-96f05246cec3", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e033d0f9-6ac0-4be8-b976-96f05246cec3" }, { "id": "cc80110c-bd03-4377-8048-f9239ace4d47", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-cc80110c-bd03-4377-8048-f9239ace4d47" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-de9d1b9a-9041-4eda-808b-40da82f614c8" }, { "name": "Update a single savings goal", "id": "1c5c0c2a-c573-43c0-8d94-cd39558fae3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "id": "4128069d-8557-44b8-aa96-7470b5d8feb1", "key": "goalId", "value": "", "description": "(Required) The Goal Id" } ] }, "description": "Requires **savings_goals:read** and either **savings_goals:write** or **savings_goals:write:all** scope." }, "response": [ { "id": "d2e38287-5fca-459f-9ad4-5b2033e08b24", "name": "Successful Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"dateCreated\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"targetDate\": \"\",\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"progressPercentage\": \"\",\n \"progressAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d2e38287-5fca-459f-9ad4-5b2033e08b24" }, { "id": "41b463e8-b536-415d-8b55-413a824bc12a", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-41b463e8-b536-415d-8b55-413a824bc12a" }, { "id": "e64c4c6d-e514-464b-b7b3-eeca0cd58d0a", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e64c4c6d-e514-464b-b7b3-eeca0cd58d0a" }, { "id": "4bc28a79-f42b-4d68-b4ff-a3a4b8c36d18", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\"\n },\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4bc28a79-f42b-4d68-b4ff-a3a4b8c36d18" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1c5c0c2a-c573-43c0-8d94-cd39558fae3e" }, { "name": "Delete a single savings goal", "id": "affa13c4-f4e9-49b4-9b38-10f4aa9891d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "id": "815bfbfe-fefe-47ec-ba5e-80e59c1a2b1f", "key": "goalId", "value": "", "description": "(Required) The Goal Id" } ] }, "description": "Requires **savings_goals:write:all** scope." }, "response": [ { "id": "dbc37184-abb7-4cc8-a047-828d2393ddc7", "name": "Successful Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-dbc37184-abb7-4cc8-a047-828d2393ddc7" }, { "id": "be5a038c-dd7a-4781-8d3a-a59222531644", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-be5a038c-dd7a-4781-8d3a-a59222531644" }, { "id": "6af17c0e-dd81-4e24-9192-0aa0a6d7676d", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6af17c0e-dd81-4e24-9192-0aa0a6d7676d" }, { "id": "e9989a63-2ca3-40e5-a746-9c346f36f172", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals/:goalId", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals", ":goalId" ], "variable": [ { "key": "goalId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e9989a63-2ca3-40e5-a746-9c346f36f172" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-affa13c4-f4e9-49b4-9b38-10f4aa9891d4" } ], "id": "99093990-0b33-4393-8de5-bd052ff9fc30", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-99093990-0b33-4393-8de5-bd052ff9fc30" }, { "name": "Retrieve all saving goals for a user", "id": "0728db4f-2a94-4152-bd80-22746ca3afad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/savings-goals?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] }, "description": "Requires **savings_goals:read** scope." }, "response": [ { "id": "395c30d8-5cb6-473f-b9e0-e974fb244873", "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"dateCreated\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"targetDate\": \"\",\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"progressPercentage\": \"\",\n \"progressAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"dateCreated\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"targetDate\": \"\",\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"progressPercentage\": \"\",\n \"progressAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-395c30d8-5cb6-473f-b9e0-e974fb244873" }, { "id": "bed2767a-fff8-47c1-a46d-2b178fc062a8", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bed2767a-fff8-47c1-a46d-2b178fc062a8" }, { "id": "e1c10ad9-a12a-4cf4-9164-c0527921f444", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/savings-goals?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e1c10ad9-a12a-4cf4-9164-c0527921f444" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0728db4f-2a94-4152-bd80-22746ca3afad" }, { "name": "Create a single savings goal for a user", "id": "3121d8e0-4eaf-41a0-b909-3ca50316506f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ] }, "description": "Requires **savings_goals:read** and **savings_goals:write:all** scopes." }, "response": [ { "id": "91ded731-4dfc-4ce7-8790-4f2da60774a7", "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"dateCreated\": \"\",\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"targetDate\": \"\",\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"progressPercentage\": \"\",\n \"progressAmount\": {\n \"value\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\",\n \"currency\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-91ded731-4dfc-4ce7-8790-4f2da60774a7" }, { "id": "30ac3ea7-4095-4d8f-9a11-b40f537dd20c", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-30ac3ea7-4095-4d8f-9a11-b40f537dd20c" }, { "id": "89b8ff7e-38ca-4d1b-932e-aacae8b4a87a", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-89b8ff7e-38ca-4d1b-932e-aacae8b4a87a" }, { "id": "f874b7fe-474d-4dea-b6d3-e711e9915256", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n },\n \"accounts\": [\n {\n \"id\": \"\"\n }\n ],\n \"imageUrl\": \"\",\n \"notes\": \"\",\n \"targetDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/savings-goals", "host": [ "{{baseUrl}}" ], "path": [ "savings-goals" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f874b7fe-474d-4dea-b6d3-e711e9915256" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3121d8e0-4eaf-41a0-b909-3ca50316506f" } ], "id": "9e9f3f5f-5005-4ff8-af15-b0e34e865844", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-9e9f3f5f-5005-4ff8-af15-b0e34e865844" }, { "name": "standard-financial-statements", "item": [ { "name": "{reportId}", "item": [ { "name": "Get an existing standard financial statement for a user", "id": "7053389b-399e-4ab7-bb19-c4e3b5663798", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements", ":reportId" ], "variable": [ { "id": "b87b7bfc-9647-4d4d-9f62-6e03955de813", "key": "reportId", "value": "", "description": "(Required) The Report Id" } ] }, "description": "Requires **standard_financial_statement:read** scope." }, "response": [ { "id": "0e56fb2e-ad29-4296-8a33-c2b0e74eb519", "name": "Successful Standard Financial Statement Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"createdAt\": \"\",\n \"id\": \"\",\n \"version\": \"2.1\",\n \"2.1\": {\n \"vehicles\": \"\",\n \"housing-tenure\": \"Owner\",\n \"client-employment-status\": \"Not working due to illness / disability\",\n \"monthly-income\": {\n \"earnings\": {\n \"client-salary-or-wages\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-earnings\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"benefits\": {\n \"tax-credits-universal-credit\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"jobseekers-allowance-contribution-based\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"income-support\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"working-tax-credit\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"child-tax-credit\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"child-benefit\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"employment-support-allowance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"disability-benefits\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"carers-allowance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-benefits\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"pensions\": {\n \"state-pensions\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"private-work-pensions\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"pension-credit\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"other-income\": {\n \"maintenance-child-support\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"boarders-lodgers\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"student-loans-grants\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-other-income\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n }\n },\n \"monthly-outgoings\": {\n \"fixed-costs\": {\n \"home-contents\": {\n \"rent\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"ground-rent-service-charges\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"mortgage\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"secured-loans\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"council-tax-rates\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"appliance-furniture-rental\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"tv-licence\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"utilities\": {\n \"gas\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-utilities-expenditure\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"water\": {\n \"water-supply\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"care-health\": {\n \"childcare-costs\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"child-maintenance-child-support\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"prescriptions-medicines\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"dentistry-opticians\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-care-health\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"transport-travel\": {\n \"public-transport\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"car-insurance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"road-tax\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"mot-ongoing-maintenance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"breakdown-cover\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"fuel-parking-toll-road-charges\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-transport-travel\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"school\": {\n \"school-uniform\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-school\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"pensions-insurance\": {\n \"pension-payments\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"life-insurance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"buildings-contents-insurance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"health-insurance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-pensions-insurances\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"professional\": {\n \"professional-courses\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"professional-fees\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"other-essential\": {\n \"other-essential-costs\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n }\n },\n \"flexible-costs\": {\n \"communications-leisure\": {\n \"home-phone-internet-tv\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"mobile-phone\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"hobbies-leisure-sport\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"gifts\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"newspapers-magazines-stationery-postage\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-communications-leisure\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"food-housekeeping\": {\n \"groceries\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"alcohol\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"smoking-products\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"vet-bills-pet-insurance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"house-repairs-maintenance\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-food-housekeeping\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n },\n \"personal\": {\n \"clothing-footwear\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"hairdressing\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"toiletries\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n },\n \"other-personal\": {\n \"monthly-amount\": {\n \"min\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"max\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"mean\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n }\n }\n }\n },\n \"currency\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0e56fb2e-ad29-4296-8a33-c2b0e74eb519" }, { "id": "e30b9388-3766-4de9-938a-39c1e73b3dbb", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e30b9388-3766-4de9-938a-39c1e73b3dbb" }, { "id": "cb2d305f-7340-4138-a394-4a9f54c52af9", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-cb2d305f-7340-4138-a394-4a9f54c52af9" }, { "id": "47fb8e3c-be8f-48e8-88a8-dbe47e5c2af1", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements/:reportId", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements", ":reportId" ], "variable": [ { "key": "reportId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-47fb8e3c-be8f-48e8-88a8-dbe47e5c2af1" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7053389b-399e-4ab7-bb19-c4e3b5663798" } ], "id": "c067e5d8-cdc0-48fd-9656-ef11022404ad", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c067e5d8-cdc0-48fd-9656-ef11022404ad" }, { "name": "List of metadata for all standard financial statements for a user", "id": "47cbd9c0-29c1-4f74-9e2e-da0a43b38724", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] }, "description": "Requires **standard_financial_statement:read** scope." }, "response": [ { "id": "a369f5c9-46da-4fd7-9295-298addc8b036", "name": "Successful Standard Financial Statement Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"requestedAt\": \"\",\n \"status\": \"failed\",\n \"statusDetails\": {\n \"message\": \"\",\n \"incididunt_6d3\": 51832355,\n \"tempor_e3\": \"eiusmod tempor occae\",\n \"irureb3\": 50892314.53714907\n }\n },\n {\n \"id\": \"\",\n \"createdAt\": \"\",\n \"requestedAt\": \"\",\n \"status\": \"failed\",\n \"statusDetails\": {\n \"message\": \"\",\n \"pariatur20\": false\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-a369f5c9-46da-4fd7-9295-298addc8b036" }, { "id": "ab165044-7e82-475e-b87a-4dc7c2a60459", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ab165044-7e82-475e-b87a-4dc7c2a60459" }, { "id": "c6bbaf76-c562-4099-b202-5ab6dd05b74a", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c6bbaf76-c562-4099-b202-5ab6dd05b74a" }, { "id": "ea116192-2183-4516-8ee7-ad5942a2e764", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/standard-financial-statements?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ea116192-2183-4516-8ee7-ad5942a2e764" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-47cbd9c0-29c1-4f74-9e2e-da0a43b38724" }, { "name": "Request standard financial statement for a user", "id": "7ac7f762-ebeb-49bc-b8e3-85288d9b202c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/standard-financial-statements", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ] }, "description": "Requires **standard_financial_statement:write** and **standard_financial_statement:read** scopes." }, "response": [ { "id": "0a1d195a-02bf-4ca7-9dbb-cb80c94d8cf3", "name": "Successful Standard Financial Statement Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/standard-financial-statements", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"status\": \"pending\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-0a1d195a-02bf-4ca7-9dbb-cb80c94d8cf3" }, { "id": "540f35c6-ace8-40eb-99b0-f8f1190f1328", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/standard-financial-statements", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-540f35c6-ace8-40eb-99b0-f8f1190f1328" }, { "id": "57d6af57-7036-4db8-8a50-880ad4275298", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/standard-financial-statements", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-57d6af57-7036-4db8-8a50-880ad4275298" }, { "id": "ef314972-129b-406f-a989-5d4a954f04f2", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"externalUserId\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/standard-financial-statements", "host": [ "{{baseUrl}}" ], "path": [ "standard-financial-statements" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ef314972-129b-406f-a989-5d4a954f04f2" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7ac7f762-ebeb-49bc-b8e3-85288d9b202c" } ], "id": "23f6ec6c-18af-4447-85e2-2613f08c4e4d", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-23f6ec6c-18af-4447-85e2-2613f08c4e4d" }, { "name": "sync", "item": [ { "name": "{connectionId}", "item": [ { "name": "Sync an existing connection", "id": "953adac1-eef7-4e5d-bee6-2eada4c22831", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customerIpAddress\": \"\",\n \"customerLastLoggedTime\": \"\",\n \"enableAsync\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sync/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "sync", ":connectionId" ], "variable": [ { "id": "8f0d61de-5730-48c3-93bd-63fb16397bbc", "key": "connectionId", "value": "", "description": "(Required) The connection id" } ] }, "description": "Requires **accounts:read** and either **accounts:write** or **accounts:write:all** scopes." }, "response": [ { "id": "e1059fc1-89d1-4bf2-8a8f-2d9b5da6ffca", "name": "Successful Sync Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerIpAddress\": \"\",\n \"customerLastLoggedTime\": \"\",\n \"enableAsync\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sync/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "sync", ":connectionId" ], "variable": [ { "key": "connectionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"syncId\": \"\",\n \"status\": \"error\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e1059fc1-89d1-4bf2-8a8f-2d9b5da6ffca" }, { "id": "d70ee7e2-7ff5-497f-82aa-d19e8333b907", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerIpAddress\": \"\",\n \"customerLastLoggedTime\": \"\",\n \"enableAsync\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sync/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "sync", ":connectionId" ], "variable": [ { "key": "connectionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d70ee7e2-7ff5-497f-82aa-d19e8333b907" }, { "id": "ebe4e989-bb70-4b6a-af03-838b6a285878", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerIpAddress\": \"\",\n \"customerLastLoggedTime\": \"\",\n \"enableAsync\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sync/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "sync", ":connectionId" ], "variable": [ { "key": "connectionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ebe4e989-bb70-4b6a-af03-838b6a285878" }, { "id": "524bcc7c-9fc6-41d6-87c9-fd5f8c3112aa", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerIpAddress\": \"\",\n \"customerLastLoggedTime\": \"\",\n \"enableAsync\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sync/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "sync", ":connectionId" ], "variable": [ { "key": "connectionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-524bcc7c-9fc6-41d6-87c9-fd5f8c3112aa" }, { "id": "519c2831-96b9-477a-93d6-57b2dc94f078", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customerIpAddress\": \"\",\n \"customerLastLoggedTime\": \"\",\n \"enableAsync\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sync/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "sync", ":connectionId" ], "variable": [ { "key": "connectionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"InternalServer\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"statusCode\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-519c2831-96b9-477a-93d6-57b2dc94f078" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-953adac1-eef7-4e5d-bee6-2eada4c22831" } ], "id": "c2c70f86-d0f9-43df-98b4-96446c9e5b4c", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c2c70f86-d0f9-43df-98b4-96446c9e5b4c" } ], "id": "63c6c8f7-ba51-472e-9e26-c036f78b468c", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-63c6c8f7-ba51-472e-9e26-c036f78b468c" }, { "name": "projects", "item": [ { "name": "{projectId}", "item": [ { "name": "Retrieve a single project", "id": "c0d78932-e057-44c9-8d45-e1e36c61e549", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "id": "ef5d317c-2228-48cd-a0a4-f0dc6625a773", "key": "projectId", "value": "", "description": "(Required) The Project Id" } ] }, "description": "Requires **projects:read** scope." }, "response": [ { "id": "26d56e40-6ad4-4762-a24b-ed958bf86537", "name": "Successful Project Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": {\n \"description\": \"The unique identifier for the project\"\n },\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"GenericProject\",\n \"dateCreated\": \"\",\n \"archived\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-26d56e40-6ad4-4762-a24b-ed958bf86537" }, { "id": "fb385ca1-5678-4685-a377-401d78de63da", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fb385ca1-5678-4685-a377-401d78de63da" }, { "id": "ce932cc1-eb1f-4b9a-a85a-c44c9987f076", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ce932cc1-eb1f-4b9a-a85a-c44c9987f076" }, { "id": "8198fe96-1b16-411d-9322-f1ee8ce721fc", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8198fe96-1b16-411d-9322-f1ee8ce721fc" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-c0d78932-e057-44c9-8d45-e1e36c61e549" }, { "name": "Update a single project", "id": "ca22b61d-c8a3-48ad-a62b-8fac519941aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"RentalProject\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "id": "00115b0f-4dc9-4aad-9e0d-a85429ff864a", "key": "projectId", "value": "", "description": "(Required) The Project Id" } ] }, "description": "Requires **projects:write** scopes." }, "response": [ { "id": "1df93c13-c108-46f8-b484-37c0a964f6a7", "name": "Successful Project Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"RentalProject\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": {\n \"description\": \"The unique identifier for the project\"\n },\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"GenericProject\",\n \"dateCreated\": \"\",\n \"archived\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-1df93c13-c108-46f8-b484-37c0a964f6a7" }, { "id": "7eca42da-c75e-4bab-9694-df56fdd47fd0", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"RentalProject\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-7eca42da-c75e-4bab-9694-df56fdd47fd0" }, { "id": "75c25342-2111-406c-9db8-8b6f04740ff6", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"RentalProject\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-75c25342-2111-406c-9db8-8b6f04740ff6" }, { "id": "bac4a2eb-3703-413d-bab2-e0e2980c2dd4", "name": "Unsuccessful Response - Resource Not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"RentalProject\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-bac4a2eb-3703-413d-bab2-e0e2980c2dd4" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-ca22b61d-c8a3-48ad-a62b-8fac519941aa" }, { "name": "Delete a single project", "id": "788b872c-f012-4de1-a435-11811303591f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "id": "9e67d3c8-5eb9-4494-a860-fd647fec8f85", "key": "projectId", "value": "", "description": "(Required) The Project Id" } ] }, "description": "This endpoint can only be used to delete projects created using the POST /projects endpoint. Projects created when connecting to a financial institution can only be deleted by removing the connection they belong to. Requires **projects:delete** scope." }, "response": [ { "id": "f6b8355d-8f3e-4b9d-aeb6-2994d0bf7d4c", "name": "Successful Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-f6b8355d-8f3e-4b9d-aeb6-2994d0bf7d4c" }, { "id": "2f5528c0-c290-4e13-beab-3daf0975b3fe", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2f5528c0-c290-4e13-beab-3daf0975b3fe" }, { "id": "935beefc-96e8-412a-9189-cc1e03645c30", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-935beefc-96e8-412a-9189-cc1e03645c30" }, { "id": "e8295a84-ebca-4bea-a0c7-766d3a2df537", "name": "Unsuccessful Response - Resource Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectId" ], "variable": [ { "key": "projectId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-e8295a84-ebca-4bea-a0c7-766d3a2df537" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-788b872c-f012-4de1-a435-11811303591f" } ], "id": "63c9bb37-38dc-422d-b2d0-8084265c98c2", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-63c9bb37-38dc-422d-b2d0-8084265c98c2" }, { "name": "Retrieve all projects for a user", "id": "59fd8f0b-7c7a-42e5-8a9b-f7c056fa37ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/projects?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] }, "description": "Requires **projects:read** scope." }, "response": [ { "id": "3fe5f661-41e7-4ffa-a2ed-cbb81348c52d", "name": "Successful Projects Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": {\n \"description\": \"The unique identifier for the project\"\n },\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"GenericProject\",\n \"dateCreated\": \"\",\n \"archived\": \"\"\n },\n {\n \"id\": {\n \"description\": \"The unique identifier for the project\"\n },\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"RentalProject\",\n \"dateCreated\": \"\",\n \"archived\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-3fe5f661-41e7-4ffa-a2ed-cbb81348c52d" }, { "id": "2b535493-793a-419a-8014-cab9f837ffef", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-2b535493-793a-419a-8014-cab9f837ffef" }, { "id": "d37fe913-a2f8-41ed-a1af-1ab8aa41f3a2", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/projects?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": "The total number of records to retrieve", "key": "limit", "value": "" }, { "description": "The offset at which to start retrieving records", "key": "offset", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d37fe913-a2f8-41ed-a1af-1ab8aa41f3a2" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-59fd8f0b-7c7a-42e5-8a9b-f7c056fa37ce" }, { "name": "Create a single project for a user", "id": "76f9953a-9357-4a9b-9baa-d01283b6ffeb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"PropertyProject\",\n \"accountIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects", "host": [ "{{baseUrl}}" ], "path": [ "projects" ] }, "description": "Requires **projects:write** scopes." }, "response": [ { "id": "6a975c4c-1bae-482c-967d-cf0bb2230a82", "name": "Successful Project Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"PropertyProject\",\n \"accountIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects", "host": [ "{{baseUrl}}" ], "path": [ "projects" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": {\n \"description\": \"The unique identifier for the project\"\n },\n \"name\": \"\",\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"type\": \"GenericProject\",\n \"dateCreated\": \"\",\n \"archived\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-6a975c4c-1bae-482c-967d-cf0bb2230a82" }, { "id": "8c50d3b8-7a06-43a8-b0ec-333646a76605", "name": "Unsuccessful Response - Bad request - Missing query parameters - Missing body properties", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"PropertyProject\",\n \"accountIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects", "host": [ "{{baseUrl}}" ], "path": [ "projects" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8c50d3b8-7a06-43a8-b0ec-333646a76605" }, { "id": "173eacf0-3394-45f9-9e66-71107ef7114a", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"PropertyProject\",\n \"accountIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects", "host": [ "{{baseUrl}}" ], "path": [ "projects" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-173eacf0-3394-45f9-9e66-71107ef7114a" }, { "id": "d195884f-eb1f-47d3-aa6c-80c2db11f90d", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"PropertyProject\",\n \"accountIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects", "host": [ "{{baseUrl}}" ], "path": [ "projects" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d195884f-eb1f-47d3-aa6c-80c2db11f90d" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-76f9953a-9357-4a9b-9baa-d01283b6ffeb" } ], "id": "d8916d84-c412-45f8-bc8f-b18f5d07ab81", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d8916d84-c412-45f8-bc8f-b18f5d07ab81" }, { "name": "tax", "item": [ { "name": "Retrieve transactions to help answer SA105 - the Self Assessment questions for properties for HMRC", "id": "d9bd0c22-6198-4999-a4dd-0ca7be197608", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tax?startDate=&endDate=&projectId=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "tax" ], "query": [ { "description": "(Required) The date to get transactions from", "key": "startDate", "value": "" }, { "description": "(Required) The date to get transactions to", "key": "endDate", "value": "" }, { "description": "The project ID the transactions belong to", "key": "projectId", "value": "" }, { "description": "The account ID the transactions belong to", "key": "accountId", "value": "" } ] }, "description": "Requires **tax:read** scope." }, "response": [ { "id": "4ba9c2b8-0adf-4d40-9cd8-3b450bed95bf", "name": "Successful Tax Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/tax?startDate=&endDate=&projectId=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "tax" ], "query": [ { "description": "(Required) The date to get transactions from", "key": "startDate", "value": "" }, { "description": "(Required) The date to get transactions to", "key": "endDate", "value": "" }, { "description": "The project ID the transactions belong to", "key": "projectId", "value": "" }, { "description": "The account ID the transactions belong to", "key": "accountId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"dateFrom\": \"\",\n \"dateTo\": \"\",\n \"taxReturn\": {\n \"sa105\": {\n \"income\": {\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"details\": [\n {\n \"category\": \"income.UDnQo\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"category\": \"income.W\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n \"expenditure\": {\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n },\n \"details\": [\n {\n \"category\": \"income.QeBSms\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"category\": \"income.tboVd\",\n \"amount\": {\n \"value\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n \"taxableIncome\": {\n \"total\": {\n \"value\": \"\",\n \"currency\": \"\",\n \"majorUnits\": \"\",\n \"minorUnits\": \"\"\n }\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\",\n \"next\": \"\",\n \"prev\": \"\"\n },\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-4ba9c2b8-0adf-4d40-9cd8-3b450bed95bf" }, { "id": "fb62cfad-7c5d-4af2-b82e-a38eeeda006f", "name": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/tax?startDate=&endDate=&projectId=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "tax" ], "query": [ { "description": "(Required) The date to get transactions from", "key": "startDate", "value": "" }, { "description": "(Required) The date to get transactions to", "key": "endDate", "value": "" }, { "description": "The project ID the transactions belong to", "key": "projectId", "value": "" }, { "description": "The account ID the transactions belong to", "key": "accountId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-fb62cfad-7c5d-4af2-b82e-a38eeeda006f" }, { "id": "8dd6a339-f8a5-4abf-b4a5-6db6f0601311", "name": "Unsuccessful Response - Forbidden - Invalid scopes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/tax?startDate=&endDate=&projectId=&accountId=", "host": [ "{{baseUrl}}" ], "path": [ "tax" ], "query": [ { "description": "(Required) The date to get transactions from", "key": "startDate", "value": "" }, { "description": "(Required) The date to get transactions to", "key": "endDate", "value": "" }, { "description": "The project ID the transactions belong to", "key": "projectId", "value": "" }, { "description": "The account ID the transactions belong to", "key": "accountId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"correlationId\": \"\",\n \"id\": \"\",\n \"userId\": \"\"\n}", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-8dd6a339-f8a5-4abf-b4a5-6db6f0601311" } ], "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-d9bd0c22-6198-4999-a4dd-0ca7be197608" } ], "id": "22109e98-6070-4fcc-85e2-4eac0ef8d69f", "createdAt": "2026-07-28T02:14:57.000Z", "updatedAt": "2026-07-28T02:14:57.000Z", "uid": "35240-22109e98-6070-4fcc-85e2-4eac0ef8d69f" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.moneyhub.co.uk/v2.0" } ] }