{ "item": [ { "id": "2e362115-7655-4ee6-b3d8-27a1c64f0136", "name": "Webhook management", "description": { "content": "Operations related to webhook management", "type": "text/plain" }, "item": [ { "id": "926e86c5-d2f5-4498-8719-5a6356a0a184", "name": "List all registered webhooks", "request": { "name": "List all registered webhooks", "description": { "content": "Retrieve a paged list of webhooks currently registered", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "26753def-2025-490e-8773-6c905dbb2296", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"id\": \"675b6998-3046-b050-4ca9-a282489aca06\",\n \"ownerUserAccountId\": \"2be9b249-7905-e901-0113-516aaf0701bf\",\n \"endpointUrl\": \"string\",\n \"algorithm\": \"SHA_256\",\n \"status\": \"ACTIVE\"\n },\n {\n \"id\": \"169a4b3d-3891-a803-7d43-9e83b2d22c2e\",\n \"ownerUserAccountId\": \"85ca9c48-226c-df90-4c15-65502b3f0968\",\n \"endpointUrl\": \"string\",\n \"algorithm\": \"SHA_256\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"page\": {\n \"size\": 9526,\n \"number\": 2181,\n \"totalElements\": 9713,\n \"totalPages\": 6208\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86423705-cbf5-4188-ad4f-2f83f54ab180", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb4bbdc1-8545-4b0f-8299-7d9840fab41b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87c8a34f-38b1-497c-a1f7-87f018dc625d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edf057df-1271-4bee-b83b-a4f6915b5630", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c39704a-1f83-4589-ba69-d2807c7cb7d9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b56fad0f-9bf8-478d-af97-be899f9eafb9", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67b6adc5-555d-4725-90cd-f63115f9c2d3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37b8b08c-ba3e-4578-9508-5958dd69b17c", "name": "Register a webhook to receive events through.", "request": { "name": "Register a webhook to receive events through.", "description": { "content": "Subscribe to one or more event types with a specified callback URL", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4a497f12-11f7-47c1-a2d7-3e9318d6b88c", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5ed9fc67-7c25-418b-8240-b20822cd42ee\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d0710f6-942b-407c-8240-34bba016349f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab83289c-0ab7-476e-9af2-5dfb1e6aafe4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78502e72-b0a6-4173-80b9-8934b44ecfa0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44772173-97a3-47e8-b51a-a760187984c3", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8898823-8a2f-4298-8b16-939f56f7f315", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52fe9385-b570-4a54-86c8-6b954c81cc8b", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e37483-44fa-46fb-950e-2f9b8e2ee18e", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22d753e5-e2ac-449c-8f46-e1edb9b80de3", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b67e6279-5099-4d1d-b266-08e75660686d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"https://your-callback.url/webhook\",\n \"eventTypes\": [\n \"v1.collection.payment_request.payment.payout.initiated\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "441b9d72-b84e-45b2-9243-e664d6ff304e", "name": "Get webhook signing secret", "request": { "name": "Get webhook signing secret", "description": { "content": "Retrieve the signing secret for a registered webhook. Use this secret to verify incoming webhook payload signatures.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "7d6251a1-b9d4-4ade-8b6c-94e18ee893bb", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52c8ff0b-fa6e-40a9-b556-9fa3d901eb8a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0ba3069-12d2-450c-a548-f9941f670f8f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f6a3ff8-8fc8-4c06-9d2e-b9fbed69f0e1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f325133-4231-494c-b663-0c70d9817db9", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82b32fe8-faa9-4085-b8da-53509d4f64e0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be21a473-ede2-4997-8c17-6b62f0fad648", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37b4a3ea-2ce4-4202-b248-845a35cfd63e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "signing-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69dba048-9fd0-4798-84d0-5d23d49f9696", "name": "Delete a registered webhook", "request": { "name": "Delete a registered webhook", "description": { "content": "Removes a previously registered webhook by its unique identifier", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "651c9934-5d9e-4dd8-95d2-02e1c3c70dc2", "name": "No Content", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0a37beb-591b-4e6b-a2af-82afec1742af", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddb91e1b-e286-4afa-ba99-a0267dff6607", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa75f98-495d-4153-827c-e8eea80776ad", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "664e385e-88d8-4496-9751-cc41fc8c1f2f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21226242-16b0-42d8-8235-92cd06b76b1d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b27e5424-e1df-4661-8e36-70a33ef59517", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd9cbf32-e0b5-45e1-9abe-e4a8b40498aa", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a434de3-a68e-475c-a8ef-4f016dcea56b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "webhookId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "cff2f1b5-76a8-4917-8a58-fec3f212041c", "name": "Connections", "description": { "content": "Partner app connection management", "type": "text/plain" }, "item": [ { "id": "1b73ce88-7996-4306-843a-0903ab074000", "name": "List connections", "request": { "name": "List connections", "description": { "content": "Lists the authenticated partner's app connections", "type": "text/plain" }, "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "0ed1db19-cfb1-4d7f-a34b-f6647beb99e6", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"connectionId\": \"4116c552-f23f-42ec-7332-9fe43a4a6873\",\n \"partnerAccountId\": \"f4ffff93-fc95-0dc9-b7f5-dd8910d124f6\",\n \"customerAccountId\": \"ef4a5e4c-dfcb-af64-8eb1-821dbadc74aa\",\n \"status\": \"ACTIVE\",\n \"expiresAt\": \"2026-01-01T00:00:00Z\",\n \"acceptedAt\": \"2026-01-01T00:00:00Z\",\n \"revokedAt\": \"2026-01-01T00:00:00Z\",\n \"revokedBy\": \"string\",\n \"createdAt\": \"2026-01-01T00:00:00Z\"\n },\n {\n \"connectionId\": \"410fc91e-9b78-ae0a-2559-adf995f24811\",\n \"partnerAccountId\": \"2aeb836a-e785-cdc1-bc96-b3c4f334b7fc\",\n \"customerAccountId\": \"582ebca5-41c9-3f75-af7e-6d0c0d4a0a0f\",\n \"status\": \"ACTIVE\",\n \"expiresAt\": \"2026-01-01T00:00:00Z\",\n \"acceptedAt\": \"2026-01-01T00:00:00Z\",\n \"revokedAt\": \"2026-01-01T00:00:00Z\",\n \"revokedBy\": \"string\",\n \"createdAt\": \"2026-01-01T00:00:00Z\"\n }\n ],\n \"page\": {\n \"size\": 839,\n \"number\": 9802,\n \"totalElements\": 7052,\n \"totalPages\": 2184\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62f537f-cbba-491e-b0ee-018a981e48e9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5af2147a-abfa-4579-92f5-4df71d7d40d3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "347aff14-be69-48f6-88b9-813a6b44fad4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4dea7a7-4741-49fe-856b-7967b6d7c12d", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33d6239f-7338-452c-acd0-e808fcbd2248", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "337968ed-8af2-4e76-bfc3-b1c483cd0a8d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "936c67f3-6197-4c3e-8217-c0c6fb571975", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "459fc7e8-4f76-4aeb-8c0b-546e809b4cf7", "name": "Create a connection request", "request": { "name": "Create a connection request", "description": { "content": "Creates a connection request for the authenticated partner and returns a deep link and token", "type": "text/plain" }, "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f009214a-253f-489b-b02f-3fb26556b52e", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connectionId\": \"33236014-1b60-106b-afc1-4166fc2a5c4e\",\n \"token\": \"string\",\n \"deepLink\": \"string\",\n \"expiresAt\": \"2026-01-01T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f504c17d-b485-4840-9dcd-f0f98fd13e83", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9211e5bf-969e-481d-8315-68c6509bba21", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e17e4a3-4ec0-4ea7-92d4-4eb3e8359519", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0705f4b8-5b1c-456f-acfb-7e9c91e1fd8e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42dae32c-bb82-4ddc-89ab-a8b0b0a3c6d2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20a8814c-f913-4009-98fa-5c343d4ffa1f", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a561d0e-4f43-42ef-a6f6-22640594839a", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eac49e39-982d-4142-93ad-e07a12897b76", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23a2d1f8-34e8-4b47-b56f-85e7680704a1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"FUNDING_ACCOUNT_READ\"\n ],\n \"accountEmail\": \"user@partner-app.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f8ee89a-554f-4f82-a793-d0a5d2b3a2d3", "name": "Get connection", "request": { "name": "Get connection", "description": { "content": "Fetches one of the authenticated partner's app connections", "type": "text/plain" }, "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "ee67368a-3135-4c0d-b356-f530324a9239", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connectionId\": \"d5e6b858-d5eb-e325-20cd-4cd7facfafda\",\n \"partnerAccountId\": \"966b0400-915d-a3a6-f879-d35ec6119eb8\",\n \"customerAccountId\": \"b056d00e-1ed0-437d-9737-993d3702839e\",\n \"status\": \"ACTIVE\",\n \"expiresAt\": \"2026-01-01T00:00:00Z\",\n \"acceptedAt\": \"2026-01-01T00:00:00Z\",\n \"revokedAt\": \"2026-01-01T00:00:00Z\",\n \"revokedBy\": \"string\",\n \"createdAt\": \"2026-01-01T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da63f9a4-03b0-41ee-a954-9734a99ae2bf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68fdb44c-cb8a-45cb-ac75-78b282095e24", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10bfc716-87a1-4a0c-8d52-ae863fbdd857", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b820586-120a-45c2-bf89-0ae0ba3fb587", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ba8b393-0e91-47d5-854b-efe756b6b2bf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80f73b7d-be24-4b0d-acb0-676b87c4ac30", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e1f0f1d-ff72-4379-9170-837a063bddb0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c437a97-7d31-4cde-8753-23beec223e8c", "name": "Revoke connection", "request": { "name": "Revoke connection", "description": { "content": "Revokes one of the authenticated partner's app connections", "type": "text/plain" }, "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "886f9600-a720-43a5-a5c5-49a2ff85c7ae", "name": "No Content", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d484ee72-6c03-467f-ac5d-21ed1610328f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cf0b21a-fa0b-4a9b-85b6-eb11ba03a243", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ec949b7-13f0-4e1f-b144-658d62372390", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0918a7a-d993-478f-81d6-431dc548dd20", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "830cf633-587e-4000-8fdc-0c259757f494", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b369551-4915-4398-90ad-630960ce9601", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1be26d50-d11e-49a1-8b47-f50c841a779b", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f941901-fe1a-4f07-a186-aa9ff49382d5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "connections", ":connectionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "connectionId", "description": "(Required) Unique identifier of the connection" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "86879bbf-1c0a-471e-a159-682c24d7cfea", "name": "Wallets", "description": { "content": "Operations related to wallets and balances", "type": "text/plain" }, "item": [ { "id": "d93202de-aebe-476c-b808-fd20cdbe6123", "name": "List wallets and balances", "request": { "name": "List wallets and balances", "description": { "content": "Returns wallets and their available balances", "type": "text/plain" }, "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "currency", "value": "AED", "description": "Optional query param to filter by currency" }, { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "c3a78f63-71bd-40b9-8153-76015666622c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"id\": \"923bdbe8-c654-bbea-0302-f090d8fdd15f\",\n \"currency\": \"LBK\",\n \"availableBalance\": 7891.097221704859,\n \"pending\": 5129.899192687648,\n \"expectedIncoming\": 3943.399655113058,\n \"expectedOutgoing\": 5022.20540868785,\n \"due\": 8566.25467174143\n },\n {\n \"id\": \"2658ec57-6d59-4be9-bd7d-6c5b4a55a83e\",\n \"currency\": \"TQP\",\n \"availableBalance\": 2404.791264334636,\n \"pending\": 7541.808371345682,\n \"expectedIncoming\": 342.67900630351454,\n \"expectedOutgoing\": 1017.0083778888039,\n \"due\": 4064.136212313387\n }\n ],\n \"page\": {\n \"size\": 4658,\n \"number\": 5990,\n \"totalElements\": 4811,\n \"totalPages\": 3252\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa2ba43c-0b14-4c25-b664-53032537a92b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9748bbab-836f-44fd-bdd5-e8e6e623a6cf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99cd42bf-bbf8-4fbf-9457-59436b8bed8a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4976e42f-e595-42ee-a546-2164d0b7aa92", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e24deba0-4bd6-491f-a521-5e631eb46401", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3574fa63-d6ee-4773-a3df-73ee8fbb053d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c7e5a9-b173-41b7-acfd-f67ac8b49a85", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8e11153f-5f3f-4a48-bb12-cbc32282bf64", "name": "Authentication", "description": { "content": "Token generation for registered clients", "type": "text/plain" }, "item": [ { "id": "c72dba69-a279-42e2-8b8f-1d846cdff40e", "name": "Generate JWT access token", "request": { "name": "Generate JWT access token", "description": { "content": "Authenticates a registered client using its ID and secret, and returns a JWT access token.", "type": "text/plain" }, "url": { "path": [ "auth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"clientId\": \"{{clientId}}\",\n \"clientSecret\": \"{{clientSecret}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "69bdf045-c2d0-4dd1-ae27-150cbd713e20", "name": "Successful token issuance", "originalRequest": { "url": { "path": [ "auth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientId\": \"your-client-id-123\",\n \"clientSecret\": \"your-client-secret-abc\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"eyJraWQiOiJ...\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "321e842f-ccb0-4129-9139-730f71b89f9d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "auth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientId\": \"your-client-id-123\",\n \"clientSecret\": \"your-client-secret-abc\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"http://peMZFHkqlhHHLaeLUBea.maT6Ca,SarWEJzmpL82Tk0mGR8EFmpSMDV-bZ,.bsqI+loP1OpvHa9QCv3+Eg8G\",\n \"title\": \"string\",\n \"status\": 8061,\n \"detail\": \"string\",\n \"instance\": \"http://niBrt.odzfqgg915oa9xN1,DroFCkRfgwIihkMOBdMw11iEGFjfLgwBu8tPVz-s2xOc5Q3\",\n \"properties\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06f16547-4a86-4ad6-a760-0287abc2d774", "name": "Invalid client credentials", "originalRequest": { "url": { "path": [ "auth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientId\": \"your-client-id-123\",\n \"clientSecret\": \"your-client-secret-abc\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"http://peMZFHkqlhHHLaeLUBea.maT6Ca,SarWEJzmpL82Tk0mGR8EFmpSMDV-bZ,.bsqI+loP1OpvHa9QCv3+Eg8G\",\n \"title\": \"string\",\n \"status\": 8061,\n \"detail\": \"string\",\n \"instance\": \"http://niBrt.odzfqgg915oa9xN1,DroFCkRfgwIihkMOBdMw11iEGFjfLgwBu8tPVz-s2xOc5Q3\",\n \"properties\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba081d90-2431-4777-aad5-f348f74f6e06", "name": "Internal server error", "originalRequest": { "url": { "path": [ "auth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientId\": \"your-client-id-123\",\n \"clientSecret\": \"your-client-secret-abc\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"http://peMZFHkqlhHHLaeLUBea.maT6Ca,SarWEJzmpL82Tk0mGR8EFmpSMDV-bZ,.bsqI+loP1OpvHa9QCv3+Eg8G\",\n \"title\": \"string\",\n \"status\": 8061,\n \"detail\": \"string\",\n \"instance\": \"http://niBrt.odzfqgg915oa9xN1,DroFCkRfgwIihkMOBdMw11iEGFjfLgwBu8tPVz-s2xOc5Q3\",\n \"properties\": {\n \"key_0\": {},\n \"key_1\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const body = pm.response.json();", "const token = body.access_token || body.accessToken || body.token;", "pm.test('Access token returned', () => pm.expect(token).to.be.a('string').and.not.empty);", "if (token) pm.collectionVariables.set('accessToken', token);" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "65718ccd-365a-4d24-9ca9-f314d50088b8", "name": "RFI", "description": { "content": "Operations for fetching and responding to RFI (Request For Information) cases", "type": "text/plain" }, "item": [ { "id": "dc2f3a00-7132-4295-92cc-3504266842b4", "name": "Submit RFI responses in bulk", "request": { "name": "Submit RFI responses in bulk", "description": { "content": "Submits a batch of question answers and document attachments in a single atomic call. If any item fails validation the whole batch is rejected and nothing is persisted.", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"3f757b8c-7c36-d8ef-84b9-fccfc7480a4d\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"22e55163-aae8-b611-ccc4-bcde667afb1f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"4777eb04-512f-95a9-760d-c1700603ebb3\",\n \"documentUploadIds\": [\n \"4d1cfc0e-17b1-3e4a-ac2c-24f78bcc2791\"\n ]\n },\n {\n \"documentRequestId\": \"8a550cf2-5cd6-3cff-ec80-32fc55b36bb6\",\n \"documentUploadIds\": [\n \"f619a859-5555-1aca-9b63-38f16c0e0ea0\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8064cf0e-88e6-44f5-8b86-d4f7e9b8cdf8", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5c26df2c-96fb-ecbb-2fc7-a86dac7c7f7e\",\n \"caseNumber\": \"string\",\n \"subjectType\": \"ONBOARDING_APPLICATION\",\n \"subjectId\": \"19bd8b41-21eb-ba18-3a94-1019a6026fab\",\n \"subjectReference\": \"string\",\n \"accountId\": \"86137834-01f0-2abd-8e4a-3c09485e0c8d\",\n \"status\": \"OPEN\",\n \"customerDisplayMessage\": \"string\",\n \"lastRespondedAt\": \"2025-06-07T14:06:36.611Z\",\n \"closedAt\": \"1970-12-02T22:32:49.659Z\",\n \"cancelledAt\": \"1977-03-27T15:40:15.009Z\",\n \"createdAt\": \"1949-07-11T11:56:07.945Z\",\n \"questions\": [\n {\n \"id\": \"77d04594-ff4d-4db3-6e54-d5ee07fb8e46\",\n \"prompt\": \"string\",\n \"displayOrder\": 1569,\n \"answer\": \"string\",\n \"answeredAt\": \"1967-11-18T19:51:45.867Z\"\n },\n {\n \"id\": \"ff85f44f-55ce-77a2-b96b-3f0040acaa3c\",\n \"prompt\": \"string\",\n \"displayOrder\": 6037,\n \"answer\": \"string\",\n \"answeredAt\": \"1996-02-15T00:30:53.618Z\"\n }\n ],\n \"documentRequests\": [\n {\n \"id\": \"3bcf4634-ad5b-1dbc-17ff-3b625ca96d58\",\n \"documentTypeId\": \"42bc9d22-8e6a-c4c0-781c-fe99b5e3f231\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 3115,\n \"documentId\": \"aa896f95-a13b-dca1-7222-b9d8ed8eaba6\",\n \"documentStatus\": \"DECLINED\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"5bdfccc6-96fd-5e6d-4d2b-03e3d1c48e50\",\n \"documentTypeId\": \"7dd22585-7777-e8e1-2207-a137e8cf8853\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 6973,\n \"documentId\": \"1f9efa2a-47ae-d0fd-5a4b-b5207766ab48\",\n \"documentStatus\": \"PENDING_REVIEW\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb603281-3bd2-42c3-89be-9b15893fd333", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4669e1b9-0ba8-4af9-a457-ffdbfa764f3d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75f4aaf9-74c0-4428-ae1b-fb8394cc2888", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97f8287b-035f-4e0d-94ad-c0a292bc31cd", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c0fc8b7-4c47-47b9-9df1-82d6e32fb6e8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7af70f3-da19-400f-aea9-3218bcd4e2dd", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2928cf72-0f5c-4a26-96f6-1f954ec659c9", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7219c37e-3a0f-471b-b6cf-947239688203", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28375c28-adda-4aae-8749-f739262045b6", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": [\n {\n \"answer\": \"string\",\n \"questionId\": \"e143b852-7190-82e8-6bd0-1c848157bca6\"\n },\n {\n \"answer\": \"string\",\n \"questionId\": \"209c193c-e993-8e63-7064-4500a236049f\"\n }\n ],\n \"attachments\": [\n {\n \"documentRequestId\": \"e51ddd23-24bd-d093-ffe1-016af745a5e4\",\n \"documentUploadIds\": [\n \"36e1d5cc-7133-60aa-cacb-38f604358e67\"\n ]\n },\n {\n \"documentRequestId\": \"23d970c0-178e-b9fc-ade4-adb751e52338\",\n \"documentUploadIds\": [\n \"ba07276e-636c-2ce2-9ea5-879564b6dc83\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0c004bf-fe35-47e2-af9f-1bc7da1ad38f", "name": "Answer an RFI question", "request": { "name": "Answer an RFI question", "description": { "content": "Submits the customer's free-text answer to a single question. Subsequent calls replace the previous answer (last-write-wins).", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "45b4d051-0c37-43fa-ba9e-8abcfcf44e88", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5c26df2c-96fb-ecbb-2fc7-a86dac7c7f7e\",\n \"caseNumber\": \"string\",\n \"subjectType\": \"ONBOARDING_APPLICATION\",\n \"subjectId\": \"19bd8b41-21eb-ba18-3a94-1019a6026fab\",\n \"subjectReference\": \"string\",\n \"accountId\": \"86137834-01f0-2abd-8e4a-3c09485e0c8d\",\n \"status\": \"OPEN\",\n \"customerDisplayMessage\": \"string\",\n \"lastRespondedAt\": \"2025-06-07T14:06:36.611Z\",\n \"closedAt\": \"1970-12-02T22:32:49.659Z\",\n \"cancelledAt\": \"1977-03-27T15:40:15.009Z\",\n \"createdAt\": \"1949-07-11T11:56:07.945Z\",\n \"questions\": [\n {\n \"id\": \"77d04594-ff4d-4db3-6e54-d5ee07fb8e46\",\n \"prompt\": \"string\",\n \"displayOrder\": 1569,\n \"answer\": \"string\",\n \"answeredAt\": \"1967-11-18T19:51:45.867Z\"\n },\n {\n \"id\": \"ff85f44f-55ce-77a2-b96b-3f0040acaa3c\",\n \"prompt\": \"string\",\n \"displayOrder\": 6037,\n \"answer\": \"string\",\n \"answeredAt\": \"1996-02-15T00:30:53.618Z\"\n }\n ],\n \"documentRequests\": [\n {\n \"id\": \"3bcf4634-ad5b-1dbc-17ff-3b625ca96d58\",\n \"documentTypeId\": \"42bc9d22-8e6a-c4c0-781c-fe99b5e3f231\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 3115,\n \"documentId\": \"aa896f95-a13b-dca1-7222-b9d8ed8eaba6\",\n \"documentStatus\": \"DECLINED\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"5bdfccc6-96fd-5e6d-4d2b-03e3d1c48e50\",\n \"documentTypeId\": \"7dd22585-7777-e8e1-2207-a137e8cf8853\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 6973,\n \"documentId\": \"1f9efa2a-47ae-d0fd-5a4b-b5207766ab48\",\n \"documentStatus\": \"PENDING_REVIEW\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0c719a6-e252-437e-b0cc-4cbefbd60008", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33c23321-efdd-4326-9312-d9df100dfe32", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7e17058-3759-4892-adb1-91543c113528", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22382fc8-0f59-4f75-87f2-682e90343281", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5b245a2-fc44-442a-8ec7-94b9de344210", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "116f48e0-88b6-4380-8cca-ff5bd5752341", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5140844a-8ea6-4ff1-848e-6e84cdd162d8", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70105d3-4dc2-46a2-ae75-4a195da9438a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0efafa37-5f0e-4a22-858c-50b6fabba7f1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "questions", ":questionId", "answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "questionId", "description": "(Required) Question identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10ee2283-7ada-4487-8e6f-ed1c174c2061", "name": "Upload a document for an RFI", "request": { "name": "Upload a document for an RFI", "description": { "content": "Uploads a file to Hubpay for use on an RFI. Returns a `DocumentUpload` whose `id` is then passed to `POST /v1/rfi/{rfiId}/document-requests/{documentRequestId}/attach` to link the upload to a document-request slot on the RFI.", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) " } ] } }, "response": [ { "id": "3da82183-84bd-4289-9f33-308193b0d1a0", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contentType\": \"string\",\n \"createdAt\": \"1985-12-10T16:12:29.371Z\",\n \"fileName\": \"string\",\n \"id\": \"e0ed9699-8a53-4618-6156-bcee4567d609\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "963c1594-4ea6-4894-bd36-9d47e9b595a6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d60a80e0-26cb-424e-be78-b2fcd84067d6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f85b0e85-eef3-48ac-814a-b6a9fb2246fa", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42907d88-d1e4-4288-9b8c-523eda54c087", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b351c76f-365d-452f-94fb-181bbd64f399", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49833e1-6cf5-49ac-abd7-20ca01ef8ef6", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f77a177f-c7b8-4fc5-90e2-6610aa75d775", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67c60363-93f2-420f-85dd-9427fb888eb0", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f978cb42-59be-4c29-a372-5bd0e0acaa12", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "279e9b97-7e22-4258-9db8-2995dd1747da", "name": "Attach documents to an RFI document-request slot", "request": { "name": "Attach documents to an RFI document-request slot", "description": { "content": "Attaches one or more previously-uploaded documents to a document-request slot on the RFI. Use `POST /v1/rfi/{rfiId}/documents/upload` to push file bytes first, then pass the returned `DocumentUpload.id` values here.", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4fb0b920-616e-46fc-9417-a79cef0d4d13", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5c26df2c-96fb-ecbb-2fc7-a86dac7c7f7e\",\n \"caseNumber\": \"string\",\n \"subjectType\": \"ONBOARDING_APPLICATION\",\n \"subjectId\": \"19bd8b41-21eb-ba18-3a94-1019a6026fab\",\n \"subjectReference\": \"string\",\n \"accountId\": \"86137834-01f0-2abd-8e4a-3c09485e0c8d\",\n \"status\": \"OPEN\",\n \"customerDisplayMessage\": \"string\",\n \"lastRespondedAt\": \"2025-06-07T14:06:36.611Z\",\n \"closedAt\": \"1970-12-02T22:32:49.659Z\",\n \"cancelledAt\": \"1977-03-27T15:40:15.009Z\",\n \"createdAt\": \"1949-07-11T11:56:07.945Z\",\n \"questions\": [\n {\n \"id\": \"77d04594-ff4d-4db3-6e54-d5ee07fb8e46\",\n \"prompt\": \"string\",\n \"displayOrder\": 1569,\n \"answer\": \"string\",\n \"answeredAt\": \"1967-11-18T19:51:45.867Z\"\n },\n {\n \"id\": \"ff85f44f-55ce-77a2-b96b-3f0040acaa3c\",\n \"prompt\": \"string\",\n \"displayOrder\": 6037,\n \"answer\": \"string\",\n \"answeredAt\": \"1996-02-15T00:30:53.618Z\"\n }\n ],\n \"documentRequests\": [\n {\n \"id\": \"3bcf4634-ad5b-1dbc-17ff-3b625ca96d58\",\n \"documentTypeId\": \"42bc9d22-8e6a-c4c0-781c-fe99b5e3f231\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 3115,\n \"documentId\": \"aa896f95-a13b-dca1-7222-b9d8ed8eaba6\",\n \"documentStatus\": \"DECLINED\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"5bdfccc6-96fd-5e6d-4d2b-03e3d1c48e50\",\n \"documentTypeId\": \"7dd22585-7777-e8e1-2207-a137e8cf8853\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 6973,\n \"documentId\": \"1f9efa2a-47ae-d0fd-5a4b-b5207766ab48\",\n \"documentStatus\": \"PENDING_REVIEW\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86693e86-3c3d-4cf0-ab46-e9a7b3cb37bf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2be5e079-6d7f-4be9-a5a9-9768bd373f4b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c851a6d8-5e5a-4e67-86f3-7c163e8d90fc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a08da712-89df-45ab-8faf-fa39775cac7f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1aeb8bd-49e8-4663-af26-e2ea4301aa65", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b06840c-e8fd-44f4-b063-aac8f5ff9b20", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f00d7188-a4bd-4a3c-ba57-99937e9047ec", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a0f66a7-6b9b-42d5-be18-6960faee8b98", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fb2ad30-80b9-42ff-b443-92c6420dc1ef", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "document-requests", ":documentRequestId", "attach" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" }, { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentRequestId", "description": "(Required) Document-request slot identifier (matches `Rfi.documentRequests[].id`)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentUploadIds\": [\n \"21d3f9d2-e761-3c16-11cb-b6c731cad96c\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd5b7d38-20d9-4acb-88a2-60dfc39fdb6d", "name": "Close an RFI (Sandbox)", "request": { "name": "Close an RFI (Sandbox)", "description": { "content": "**Non-production only.** Transitions the identified RFI to `CLOSED` and dispatches the\n`v1.rfi.case.closed` webhook.\n\nSee the [sandbox testing guide](/docs/guides/responding-to-rfi/testing).\n", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", ":rfiId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "6092589e-8f3e-40bf-ab3f-9f033cae48c8", "name": "RFI closed; the corresponding webhook has been dispatched.", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1acc9e23-c575-44e4-8025-d4daae8ea67f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd4744ab-24c8-4c13-908e-75633bc7749b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "093c6b7b-4229-4067-a6b3-65fecced2337", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abc15511-b7a4-445d-ba95-5230069c51e6", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a653ea0-a1ba-4ece-829f-3c21a6f53c19", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30bab048-9b2c-436e-aa79-213ae89d4e00", "name": "Cancel an RFI (Sandbox)", "request": { "name": "Cancel an RFI (Sandbox)", "description": { "content": "**Non-production only.** Transitions the identified RFI to `CANCELLED` and dispatches the\n`v1.rfi.case.cancelled` webhook.\n\nSee the [sandbox testing guide](/docs/guides/responding-to-rfi/testing).\n", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", ":rfiId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "26f9d05c-ad21-4ccf-837c-0b24a4f405d8", "name": "RFI cancelled; the corresponding webhook has been dispatched.", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7919272c-48a0-4dd0-8b79-40f4ccf9d1a0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e61e01b4-9f5a-482a-98e3-9ff11d473ca3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d1b3416-589d-48ff-aa9b-d13a5ee874a5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2370b6a-e9c8-4100-880f-323d8a5e6af8", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a590e937-3a61-4341-a327-388eb3d7202e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellationReason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f453ccb6-e820-4dec-9b8d-65af85bdbbc3", "name": "Open an RFI (Sandbox)", "request": { "name": "Open an RFI (Sandbox)", "description": { "content": "**Non-production only.** Opens a new RFI against the calling partner's account and\ndispatches the `v1.rfi.case.opened` webhook. The owning account is resolved from the\n`AccountId` header. Partners cannot open an RFI on another partner's account.\n\nAt least one question or one document request must be provided.\n\nSee the [sandbox testing guide](/docs/guides/responding-to-rfi/testing).\n", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subjectId\": \"ef31908d-981a-e6fa-17b3-d88b21c99fa3\",\n \"subjectType\": \"MULTI_TRANSACTION\",\n \"subjectReference\": \"string\",\n \"customerDisplayMessage\": \"string\",\n \"questions\": [\n {\n \"prompt\": \"string\"\n },\n {\n \"prompt\": \"string\"\n }\n ],\n \"documentRequests\": [\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n },\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "044822f0-560c-4311-9e20-1dd03d5a5279", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "rfi", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account on which to open the RFI", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subjectId\": \"e36354aa-8be5-84d2-5b83-8b2776bb02cd\",\n \"subjectType\": \"TRANSACTION\",\n \"subjectReference\": \"string\",\n \"customerDisplayMessage\": \"string\",\n \"questions\": [\n {\n \"prompt\": \"string\"\n },\n {\n \"prompt\": \"string\"\n }\n ],\n \"documentRequests\": [\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n },\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5c26df2c-96fb-ecbb-2fc7-a86dac7c7f7e\",\n \"caseNumber\": \"string\",\n \"subjectType\": \"ONBOARDING_APPLICATION\",\n \"subjectId\": \"19bd8b41-21eb-ba18-3a94-1019a6026fab\",\n \"subjectReference\": \"string\",\n \"accountId\": \"86137834-01f0-2abd-8e4a-3c09485e0c8d\",\n \"status\": \"OPEN\",\n \"customerDisplayMessage\": \"string\",\n \"lastRespondedAt\": \"2025-06-07T14:06:36.611Z\",\n \"closedAt\": \"1970-12-02T22:32:49.659Z\",\n \"cancelledAt\": \"1977-03-27T15:40:15.009Z\",\n \"createdAt\": \"1949-07-11T11:56:07.945Z\",\n \"questions\": [\n {\n \"id\": \"77d04594-ff4d-4db3-6e54-d5ee07fb8e46\",\n \"prompt\": \"string\",\n \"displayOrder\": 1569,\n \"answer\": \"string\",\n \"answeredAt\": \"1967-11-18T19:51:45.867Z\"\n },\n {\n \"id\": \"ff85f44f-55ce-77a2-b96b-3f0040acaa3c\",\n \"prompt\": \"string\",\n \"displayOrder\": 6037,\n \"answer\": \"string\",\n \"answeredAt\": \"1996-02-15T00:30:53.618Z\"\n }\n ],\n \"documentRequests\": [\n {\n \"id\": \"3bcf4634-ad5b-1dbc-17ff-3b625ca96d58\",\n \"documentTypeId\": \"42bc9d22-8e6a-c4c0-781c-fe99b5e3f231\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 3115,\n \"documentId\": \"aa896f95-a13b-dca1-7222-b9d8ed8eaba6\",\n \"documentStatus\": \"DECLINED\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"5bdfccc6-96fd-5e6d-4d2b-03e3d1c48e50\",\n \"documentTypeId\": \"7dd22585-7777-e8e1-2207-a137e8cf8853\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 6973,\n \"documentId\": \"1f9efa2a-47ae-d0fd-5a4b-b5207766ab48\",\n \"documentStatus\": \"PENDING_REVIEW\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f49431c0-4b12-4136-ba13-c9bb733e61dd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account on which to open the RFI", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subjectId\": \"e36354aa-8be5-84d2-5b83-8b2776bb02cd\",\n \"subjectType\": \"TRANSACTION\",\n \"subjectReference\": \"string\",\n \"customerDisplayMessage\": \"string\",\n \"questions\": [\n {\n \"prompt\": \"string\"\n },\n {\n \"prompt\": \"string\"\n }\n ],\n \"documentRequests\": [\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n },\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a4c5978-5193-4262-ae6a-d7f5f5a588a5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account on which to open the RFI", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subjectId\": \"e36354aa-8be5-84d2-5b83-8b2776bb02cd\",\n \"subjectType\": \"TRANSACTION\",\n \"subjectReference\": \"string\",\n \"customerDisplayMessage\": \"string\",\n \"questions\": [\n {\n \"prompt\": \"string\"\n },\n {\n \"prompt\": \"string\"\n }\n ],\n \"documentRequests\": [\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n },\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f544b1c7-6a4e-41ec-8695-f22e70d1897e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account on which to open the RFI", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subjectId\": \"e36354aa-8be5-84d2-5b83-8b2776bb02cd\",\n \"subjectType\": \"TRANSACTION\",\n \"subjectReference\": \"string\",\n \"customerDisplayMessage\": \"string\",\n \"questions\": [\n {\n \"prompt\": \"string\"\n },\n {\n \"prompt\": \"string\"\n }\n ],\n \"documentRequests\": [\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n },\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd99ac8c-9084-4679-b722-739238651d5e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account on which to open the RFI", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subjectId\": \"e36354aa-8be5-84d2-5b83-8b2776bb02cd\",\n \"subjectType\": \"TRANSACTION\",\n \"subjectReference\": \"string\",\n \"customerDisplayMessage\": \"string\",\n \"questions\": [\n {\n \"prompt\": \"string\"\n },\n {\n \"prompt\": \"string\"\n }\n ],\n \"documentRequests\": [\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n },\n {\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1af10109-22f7-4aaa-b378-61e6a9311731", "name": "Decline an RFI document (Sandbox)", "request": { "name": "Decline an RFI document (Sandbox)", "description": { "content": "**Non-production only.** Marks the RFI document as `DECLINED` and dispatches the\n`v1.rfi.document.declined` webhook.\n\nSee the [sandbox testing guide](/docs/guides/responding-to-rfi/testing).\n", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to decline" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "94d610b4-a757-4bac-bd7d-b2c51188a4a4", "name": "Document declined; the corresponding webhook has been dispatched.", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d2f8621-f7af-4353-95ca-ca05546fd4c8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8afb702e-4014-4827-8bd6-fbb94c1504f2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "141ea3fc-533f-43cf-9cb4-82fb858ee02c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d04be06e-a9c0-4bae-8987-bd8f76e8f973", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b15ec8db-413d-43c2-b927-b282bf0bab5b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e09edbf6-f6c6-44b4-9e6b-e7b8bc224bc9", "name": "Approve an RFI document (Sandbox)", "request": { "name": "Approve an RFI document (Sandbox)", "description": { "content": "**Non-production only.** Marks the RFI document as `APPROVED` and dispatches the\n`v1.rfi.document.approved` webhook.\n\nSee the [sandbox testing guide](/docs/guides/responding-to-rfi/testing).\n", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to approve" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "30ce876a-6a5c-4a78-a725-b92b3a9c7d01", "name": "Document approved; the corresponding webhook has been dispatched.", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7260456a-dead-484a-8bef-c50d2c2900f6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddfcead6-170d-44ad-8585-4d33722bc634", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2726af08-7d51-45b6-9856-57edf78ca2bd", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a09f75bd-a02c-44fb-8a46-61c08dc52f45", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "documentId", "description": "(Required) ID of the RFI document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI document belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8751caa-fb1e-468c-86d8-578f924a5989", "name": "List RFIs", "request": { "name": "List RFIs", "description": { "content": "Returns RFI cases raised against the account. By default only OPEN RFIs are returned; set `includeTerminal=true` to also include CLOSED and CANCELLED cases.", "type": "text/plain" }, "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "includeTerminal", "value": "false", "description": "If true, includes CLOSED and CANCELLED RFIs alongside OPEN ones. Defaults to false." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "7328a844-3b62-4628-90fb-855a64046a8d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeTerminal", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFIs belong to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"fead6fb2-6988-5a56-d89f-8d16ce874833\",\n \"caseNumber\": \"string\",\n \"subjectType\": \"ONBOARDING_APPLICATION\",\n \"subjectId\": \"c14fb57e-fb2e-8898-b426-978d3a0e2840\",\n \"subjectReference\": \"string\",\n \"accountId\": \"79ceb22e-3c6f-aa7c-a55d-b67dbbc16f0a\",\n \"status\": \"CLOSED\",\n \"customerDisplayMessage\": \"string\",\n \"lastRespondedAt\": \"1947-01-30T21:58:29.990Z\",\n \"createdAt\": \"2024-11-13T18:47:06.391Z\"\n },\n {\n \"id\": \"6c5f9d4f-f490-158d-2735-9a12734e6b10\",\n \"caseNumber\": \"string\",\n \"subjectType\": \"TRANSACTION\",\n \"subjectId\": \"756f8033-1f2e-8947-cb16-4a301ea41da6\",\n \"subjectReference\": \"string\",\n \"accountId\": \"02e7aee5-641e-1c4d-6e81-0a80e707eb84\",\n \"status\": \"CANCELLED\",\n \"customerDisplayMessage\": \"string\",\n \"lastRespondedAt\": \"2008-12-31T13:26:19.850Z\",\n \"createdAt\": \"2003-05-26T12:44:29.258Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a70c586d-c16c-4c6d-84f5-c9ed1f6e6361", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeTerminal", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFIs belong to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43b80735-c507-4023-8541-0d66aa0214a4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeTerminal", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFIs belong to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "212209ce-e35f-4417-96b6-66cfd68d2a21", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeTerminal", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFIs belong to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed1caa5e-148b-4dde-8f90-0d9f2cd3f414", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeTerminal", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFIs belong to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cb6c585-68a5-4249-83bb-a514f89fbf30", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeTerminal", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFIs belong to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62a10ce3-0a07-43c2-a01a-8f98b9ba0fb9", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeTerminal", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFIs belong to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8cd456f-7919-4b2c-b392-0ca7a063d410", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeTerminal", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFIs belong to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b086b200-fb60-43eb-8108-2ee95c19c929", "name": "Get RFI", "request": { "name": "Get RFI", "description": { "content": "Returns the full RFI case, including questions and document requests.", "type": "text/plain" }, "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "199279a1-de5a-4daf-bc28-67d03187a109", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5c26df2c-96fb-ecbb-2fc7-a86dac7c7f7e\",\n \"caseNumber\": \"string\",\n \"subjectType\": \"ONBOARDING_APPLICATION\",\n \"subjectId\": \"19bd8b41-21eb-ba18-3a94-1019a6026fab\",\n \"subjectReference\": \"string\",\n \"accountId\": \"86137834-01f0-2abd-8e4a-3c09485e0c8d\",\n \"status\": \"OPEN\",\n \"customerDisplayMessage\": \"string\",\n \"lastRespondedAt\": \"2025-06-07T14:06:36.611Z\",\n \"closedAt\": \"1970-12-02T22:32:49.659Z\",\n \"cancelledAt\": \"1977-03-27T15:40:15.009Z\",\n \"createdAt\": \"1949-07-11T11:56:07.945Z\",\n \"questions\": [\n {\n \"id\": \"77d04594-ff4d-4db3-6e54-d5ee07fb8e46\",\n \"prompt\": \"string\",\n \"displayOrder\": 1569,\n \"answer\": \"string\",\n \"answeredAt\": \"1967-11-18T19:51:45.867Z\"\n },\n {\n \"id\": \"ff85f44f-55ce-77a2-b96b-3f0040acaa3c\",\n \"prompt\": \"string\",\n \"displayOrder\": 6037,\n \"answer\": \"string\",\n \"answeredAt\": \"1996-02-15T00:30:53.618Z\"\n }\n ],\n \"documentRequests\": [\n {\n \"id\": \"3bcf4634-ad5b-1dbc-17ff-3b625ca96d58\",\n \"documentTypeId\": \"42bc9d22-8e6a-c4c0-781c-fe99b5e3f231\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 3115,\n \"documentId\": \"aa896f95-a13b-dca1-7222-b9d8ed8eaba6\",\n \"documentStatus\": \"DECLINED\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"5bdfccc6-96fd-5e6d-4d2b-03e3d1c48e50\",\n \"documentTypeId\": \"7dd22585-7777-e8e1-2207-a137e8cf8853\",\n \"displayTitle\": \"string\",\n \"customLabel\": \"string\",\n \"perItemDisplayMessage\": \"string\",\n \"displayOrder\": 6973,\n \"documentId\": \"1f9efa2a-47ae-d0fd-5a4b-b5207766ab48\",\n \"documentStatus\": \"PENDING_REVIEW\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f401abe4-0f38-4086-bcd4-959a7238c37b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84eb44f6-35aa-4e45-8928-7ae6c4377bae", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a75fd70-87ea-49f0-9626-eced45533063", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcc18854-11d3-4203-948e-02001b31aa95", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17627fbe-366a-42bc-b3fd-639940a6d9f3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71d4d6e8-fee4-485f-8dd0-e19a7c046729", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09bf4431-e6c3-4c27-acba-b1b40388ef66", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "rfi", ":rfiId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "rfiId", "description": "(Required) RFI identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account the RFI belongs to", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fdd7902e-a7b4-4f3c-baec-bf02fd21d23b", "name": "Payments", "description": { "content": "Operations related to Payments", "type": "text/plain" }, "item": [ { "id": "ff07f688-ef3e-454a-b5f6-ad0bfcf27393", "name": "Create payments", "request": { "name": "Create payments", "description": { "content": "Initiate a new payment request with the provided details", "type": "text/plain" }, "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d4100454-49df-4996-89b1-319306dc2802", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"externalId\": \"EXT123\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"purposeOfPayment\": \"CONSTRUCTION_EXPENSES\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"status\": {\n \"state\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n },\n \"complete\": {\n \"value\": \"\"\n }\n },\n \"completedAt\": \"2023-01-01T00:00:00Z\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"paymentProperties\": {}\n },\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"externalId\": \"EXT123\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"purposeOfPayment\": \"FUND_INVESTMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"status\": {\n \"state\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n },\n \"complete\": {\n \"value\": \"\"\n }\n },\n \"completedAt\": \"2023-01-01T00:00:00Z\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"paymentProperties\": {}\n }\n ],\n \"page\": {\n \"size\": 2911,\n \"number\": 63,\n \"totalElements\": 7916,\n \"totalPages\": 1480\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8b9d34e-711a-4e9e-bb53-4982819bb642", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "999f56a4-648b-4222-af9c-04bd9093dba9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f943a8dc-a966-4ca7-ae9b-367d48f19cee", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b6dd682-0584-4c0c-8002-414e3c7aaa75", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "588f79de-0269-4455-9597-806148d3efc8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da162992-81e5-4493-9637-0e47b66a493a", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58959710-f337-4d39-a34b-aeeecc734999", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f417ed3-e591-4fb6-b5b5-ea95bfbcc956", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18ecdb3d-1bec-4a92-8762-c19fafe94331", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"externalId\": \"EXT123\",\n \"purposeOfPayment\": \"SALARY_PAYMENT\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"base64EncodedFile\": {\n \"value\": \"\"\n },\n \"mediaType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea7f7ad1-061a-40dc-ba6e-11f98d21e034", "name": "Create a payment quote", "request": { "name": "Create a payment quote", "description": { "content": "Initiate a new payment quote request with the provided details", "type": "text/plain" }, "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dde46bcb-4479-4781-af71-79b52633eb8b", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fee\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "885b2648-934f-4223-9b29-f49519b54185", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8db1359-a91a-4e52-b576-ad194b7943dd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b8cb9e3-5c22-4aa9-8c77-c006a6773507", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f7e192e-daa5-4833-835f-7b6a7881bd14", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04e05ce0-46c2-4fb2-b622-285fe74ab5f3", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed6a287-be06-46db-83bf-2441de791676", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d43a8c0-d3fd-46bd-a6cc-5b0cc8d538a0", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c562a9e-2ff9-46aa-8d43-0ce364d7ff15", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e93fdb4-8240-4749-85f2-e8188b524ce2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "payments", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"AE\",\n \"currency\": \"AED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7f70488-151b-486c-a30e-24f0c38292cc", "name": "Get a payment", "request": { "name": "Get a payment", "description": { "content": "Retrieve a single payment by id", "type": "text/plain" }, "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "6f2a8706-fb1b-44d7-801d-7546f46620a2", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"beneficiaryId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"externalId\": \"EXT123\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"purposeOfPayment\": \"EXPORTED_GOODS\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"REF123\",\n \"status\": {\n \"state\": \"PAID\",\n \"reason\": \"string\",\n \"complete\": false\n },\n \"completedAt\": \"2023-01-01T00:00:00Z\",\n \"documentReference\": \"DOC123\",\n \"document\": {\n \"mediaType\": \"application/pdf\",\n \"name\": \"document.pdf\"\n },\n \"paymentProperties\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05775bf8-9057-4af1-92f9-0d242969357d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa598af9-c403-4e85-801d-9d6227e9baf3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba64c13c-d576-40e2-8b0a-7d319d64700b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd35b0b2-d302-4c2d-84f7-4876e6b70e15", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c425442-5247-487a-8835-d11ede7fae7b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54ac21b9-85f5-436a-813d-7c16fb494eb0", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c524200-6219-453e-968b-18f474d7d90b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "payments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "31d5a552-605f-443c-859c-3bf9c72a5127", "name": "Funding accounts", "description": { "content": "Retrieval of funding accounts on currencies the account holding a wallet", "type": "text/plain" }, "item": [ { "id": "6f4b0725-f7c5-46a3-a2bc-e06fe8b590c4", "name": "Retrieve funding accounts per currency", "request": { "name": "Retrieve funding accounts per currency", "description": {}, "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "currency", "value": "AED", "description": "(Required) Required query param to filter funding accounts by currency" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "456f7dc0-159c-476e-9b78-b554727de271", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"accountNumber\": \"string\",\n \"routingCode\": \"string\",\n \"accountName\": \"string\",\n \"bankName\": \"string\",\n \"bankAddress\": \"string\",\n \"currency\": \"string\",\n \"paymentMethod\": \"UK Faster Payment\"\n },\n {\n \"accountNumber\": \"string\",\n \"routingCode\": \"string\",\n \"accountName\": \"string\",\n \"bankName\": \"string\",\n \"bankAddress\": \"string\",\n \"currency\": \"string\",\n \"paymentMethod\": \"UK Faster Payment\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b007a161-4264-4a27-bdbf-e074088bc8e7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f786916b-2d0f-4741-bce8-0f1f6be47cc0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3711dd15-5f8e-4ea4-b919-5125fad03af0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66276b46-dc7a-4f36-8c7f-3147c20b7844", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4dba9e3-d705-464a-861b-9daa0ef76e66", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1352611b-c75c-49c3-898c-0da562786f53", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb960003-c321-45bf-9fa9-8ab290e8ab6c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "funding-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "currency", "value": "AED" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ba561da1-7d46-4a54-b5f3-77421da365fa", "name": "Exchange", "description": { "content": "Operations related to foreign exchange", "type": "text/plain" }, "item": [ { "id": "5143a86c-882f-4e76-979e-8a5a0888d968", "name": "Get an exchange quote", "request": { "name": "Get an exchange quote", "description": { "content": "Retrieve a market price quote based on the provided request.", "type": "text/plain" }, "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0792481c-ce4c-4750-9a5a-15cf8ec6c649", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"expiresAt\": \"2023-12-31\",\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"id\": \"2f34fee4-258c-2218-17f3-96f961889dca\",\n \"rate\": {\n \"currencyPair\": \"string\",\n \"price\": 2027.4096226633076,\n \"type\": \"BID\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b310a0b-5d04-431b-8f19-842f34c515da", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9797ade7-0d6c-4bde-a94d-4bac88d82fbf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9939cb90-75aa-4cc4-aeaf-f9001206954d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06b21cac-067b-4593-8d1e-9b98a7611563", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d59ee5f4-d501-4a05-b05f-ae02c32e2351", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52a2d560-3311-4c3f-ae41-cd8d235565b1", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ff9e49b-4f5e-496e-8265-cac5a10fa5e5", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62d83c2e-c223-4fa9-adb8-87668f559c6a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7b09e4-7b7b-4347-97e9-f3fbfb8f3a71", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd8974b8-812a-4732-97f1-b7a2cf3badf1", "name": "Make an order", "request": { "name": "Make an order", "description": { "content": "Create an FX order based on the provided request.", "type": "text/plain" }, "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4924046b-fdba-4018-9cbb-6ab53698f33c", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"exchangeStatus\": {\n \"state\": \"SUBMITTED\",\n \"reason\": \"UNKNOWN\",\n \"complete\": false\n },\n \"externalId\": \"EX123\",\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"rate\": {\n \"currencyPair\": \"string\",\n \"price\": 7812.064699776147,\n \"type\": \"BID\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"shortId\": \"TR123\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"completedAt\": \"2023-01-02T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78eb2828-4a0e-49f3-b863-031b2efd8ee8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aad7af09-2176-497f-b4bd-964a49d10447", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "970a21a6-f215-40e3-9e7d-bdc469431781", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aff2de26-411f-4378-a9a0-0626ab7fcb2a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b05fcf0-6270-41bc-9b27-4993360398c8", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b43541-8bb9-4dd4-a6e0-e92925dc7547", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed461937-ef66-4a0a-9010-c8ae54379e0f", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6e930d6-7805-44d1-be97-68c3c7c7e5d8", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf210f88-b99c-4a33-9785-09eb17ea2139", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"externalId\": \"clientGeneratedId\",\n \"quoteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f05e9cd-836d-4d8a-b8dc-1a0e6c907af2", "name": "Lookup an exchange by ID", "request": { "name": "Lookup an exchange by ID", "description": {}, "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "068f9e3b-3c36-4c47-9f93-b71cad59b0cd", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"exchangeStatus\": {\n \"state\": \"SUBMITTED\",\n \"reason\": \"UNKNOWN\",\n \"complete\": false\n },\n \"externalId\": \"EX123\",\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"rate\": {\n \"currencyPair\": \"string\",\n \"price\": 7812.064699776147,\n \"type\": \"BID\"\n },\n \"settlementDate\": \"2023-12-31\",\n \"shortId\": \"TR123\",\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"completedAt\": \"2023-01-02T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83d17926-1aaf-4791-88ad-9b399e79119c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af79cdb3-1a0d-42be-8cce-526f5094054c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae56513f-ff99-40d2-9075-7c984e5745f1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82069943-283b-4440-aff8-2f03e72c81b9", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cdb1447-f52c-4534-8fed-1cddde1b72b6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87b8b669-6dd7-42bf-b254-821bec4f217f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c73e781a-d6b5-4aba-86ca-e72f68b7ccd4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "orders", "exchange", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the exchange" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9413a0a1-f2a8-4403-afdf-21a0d36a1c42", "name": "Beneficiaries", "description": { "content": "Beneficiary management", "type": "text/plain" }, "item": [ { "id": "59a704c3-bdf9-480b-b555-2aee92d7c1b5", "name": "Get beneficiary", "request": { "name": "Get beneficiary", "description": { "content": "Fetches the beneficiary details based on provided id", "type": "text/plain" }, "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "71736e39-44d4-4929-b818-31bc30d54017", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"277bdb9a-33d7-d0f8-8085-fee561c837f2\",\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"beneficiaryStatus\": \"FAILED\",\n \"createdAt\": \"2021-01-04T06:18:15.348Z\",\n \"externalId\": \"string\",\n \"id\": \"62b63a2d-8b8d-61a4-b86d-4c1b42577593\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eeb2325-b440-4689-8f70-80f625bf3750", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10689a67-6721-402b-bd34-35ac02aeb15b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a875a15-f501-43d3-885d-04188e39f6b7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "890e7c5d-03da-4105-8131-e85e3d447d3e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "823460fb-9781-409c-8ee9-cab3e55b0fe9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c43ab96-4e38-4306-b91e-03dba60abcc8", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7056a4ed-4af2-4d55-abc4-2e6911ef0d9d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1e2851d-c74b-4619-bd1f-413512187b88", "name": "Update a beneficiary", "request": { "name": "Update a beneficiary", "description": { "content": "Update a beneficiary", "type": "text/plain" }, "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "04e08033-5eb8-448f-ba1f-6c8df1266813", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"277bdb9a-33d7-d0f8-8085-fee561c837f2\",\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"beneficiaryStatus\": \"FAILED\",\n \"createdAt\": \"2021-01-04T06:18:15.348Z\",\n \"externalId\": \"string\",\n \"id\": \"62b63a2d-8b8d-61a4-b86d-4c1b42577593\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "720e481c-4a30-4084-9900-99501356e898", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5b4cf28-7ca3-4f44-9232-08e0bb4be2d5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9424e7a-26d5-47f0-a077-b1f4ba02995b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f98f495-a33b-4d10-bf65-b2d934e0a066", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dadcecfb-74f6-45be-955e-b0cb901b02c1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f579405-a596-4db6-9b51-cbf2b6a41162", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0f93ec6-a1c6-4707-91c4-81bc88f96ef3", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87791cab-03e7-42c2-ac41-e323f23c7c71", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the beneficiary" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "411725d5-3654-4572-941f-2aa03f90b14c", "name": "Lists beneficiaries", "request": { "name": "Lists beneficiaries", "description": { "content": "Get a list of beneficiaries for the account", "type": "text/plain" }, "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "accountNumber", "value": "string", "description": "Optional query param to filter by accountNumber (bank account number or iban of a beneficiary)" }, { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "d19d8dec-eb1f-4c15-a21a-1372c0341ac2", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountNumber", "value": "string" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"accountId\": \"b3886346-4230-c1c7-15e6-c9f23bc4aa66\",\n \"bankDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"bankCountry\": {\n \"value\": \"\"\n },\n \"bic\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"bankCode\": {\n \"value\": \"\"\n },\n \"bankName\": {\n \"value\": \"\"\n },\n \"bankBranchName\": {\n \"value\": \"\"\n },\n \"bankAddress\": {\n \"value\": \"\"\n },\n \"bankCity\": {\n \"value\": \"\"\n },\n \"bankProvince\": {\n \"value\": \"\"\n },\n \"bankPostalCode\": {\n \"value\": \"\"\n },\n \"accountType\": {\n \"value\": \"\"\n },\n \"branchCode\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryStatus\": \"VERIFIED\",\n \"createdAt\": \"1954-08-24T08:35:53.704Z\",\n \"externalId\": \"string\",\n \"id\": \"6c60c467-8885-c014-7e62-4212bedb4738\",\n \"personalDetails\": {\n \"addressLine1\": {\n \"value\": \"\"\n },\n \"country\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"addressLine2\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"postalCode\": {\n \"value\": \"\"\n },\n \"phoneNumber\": {\n \"value\": \"\"\n },\n \"taxId\": {\n \"value\": \"\"\n },\n \"idNumber\": {\n \"value\": \"\"\n },\n \"contactName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"accountId\": \"d2e102ea-e9ea-7640-ed19-7eb71f0811bd\",\n \"bankDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"bankCountry\": {\n \"value\": \"\"\n },\n \"bic\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"bankCode\": {\n \"value\": \"\"\n },\n \"bankName\": {\n \"value\": \"\"\n },\n \"bankBranchName\": {\n \"value\": \"\"\n },\n \"bankAddress\": {\n \"value\": \"\"\n },\n \"bankCity\": {\n \"value\": \"\"\n },\n \"bankProvince\": {\n \"value\": \"\"\n },\n \"bankPostalCode\": {\n \"value\": \"\"\n },\n \"accountType\": {\n \"value\": \"\"\n },\n \"branchCode\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryStatus\": \"VERIFIED\",\n \"createdAt\": \"1967-05-04T07:38:10.897Z\",\n \"externalId\": \"string\",\n \"id\": \"0f4c452d-2c79-a24e-a836-e3883f1839bc\",\n \"personalDetails\": {\n \"addressLine1\": {\n \"value\": \"\"\n },\n \"country\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"addressLine2\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"postalCode\": {\n \"value\": \"\"\n },\n \"phoneNumber\": {\n \"value\": \"\"\n },\n \"taxId\": {\n \"value\": \"\"\n },\n \"idNumber\": {\n \"value\": \"\"\n },\n \"contactName\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"page\": {\n \"size\": 9143,\n \"number\": 5436,\n \"totalElements\": 5324,\n \"totalPages\": 2577\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9121d4b9-6bd4-44b5-be0b-2c1bd3bd3104", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountNumber", "value": "string" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13250389-fc0f-429c-8450-6917d78686b8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountNumber", "value": "string" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b865c926-a733-4d6a-9612-0bbd30697b88", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountNumber", "value": "string" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96624852-a690-4401-aa20-2de88d05f005", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountNumber", "value": "string" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f87297e5-2d02-40c5-be2c-f0fc0c42a40a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountNumber", "value": "string" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d948a30-3130-4429-bccb-c97f9fc6a7fc", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountNumber", "value": "string" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f303d1ce-5be0-4399-bf21-89a39a28f685", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountNumber", "value": "string" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d08e9053-5a0d-4bad-86bb-e49699ec92a2", "name": "Create beneficiary", "request": { "name": "Create beneficiary", "description": { "content": "Create beneficiary", "type": "text/plain" }, "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "29773a2f-d043-446a-af99-41ea7242a6e9", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"277bdb9a-33d7-d0f8-8085-fee561c837f2\",\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"beneficiaryStatus\": \"FAILED\",\n \"createdAt\": \"2021-01-04T06:18:15.348Z\",\n \"externalId\": \"string\",\n \"id\": \"62b63a2d-8b8d-61a4-b86d-4c1b42577593\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1be83a4-a408-4ef4-b408-13f1ae7f58e0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abf117f9-b9b0-4835-94ae-2629085dd705", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d74f4b3-18d2-40fc-98f2-148ea0c2abfa", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "939b7c84-ea95-47fe-b12b-3e21b8cd8c18", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13eda011-3ac6-4dee-964a-a81a51901ee1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad7b6ae5-ceb4-42d6-993c-277abb2a908d", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aca831ee-2dfa-46b5-9d12-e764b45b5f62", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c3e8487-f389-42eb-9088-7bb85c1e83ff", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdc955f7-cb16-494d-991a-6a0d65c05b30", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "beneficiaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"bankDetails\": {\n \"accountNumber\": \"string\",\n \"bankCountry\": \"AE\",\n \"bic\": \"string\",\n \"currency\": \"AED\",\n \"bankCode\": \"BANK123\",\n \"bankName\": \"string\",\n \"bankBranchName\": \"string\",\n \"bankAddress\": \"string\",\n \"bankCity\": \"string\",\n \"bankProvince\": \"string\",\n \"bankPostalCode\": \"string\",\n \"accountType\": \"SAVINGS\",\n \"branchCode\": \"string\"\n },\n \"externalId\": \"string\",\n \"personalDetails\": {\n \"addressLine1\": \"string\",\n \"country\": \"AE\",\n \"name\": \"string\",\n \"type\": \"BUSINESS\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"phoneNumber\": \"string\",\n \"taxId\": \"string\",\n \"idNumber\": \"string\",\n \"contactName\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ee5f88b-7feb-4a4e-a93e-198655a10769", "name": "Find beneficiaries by external ID", "request": { "name": "Find beneficiaries by external ID", "description": { "content": "Find beneficiaries for an account by external ID", "type": "text/plain" }, "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "externalId", "value": "EXT-001", "description": "(Required) External ID to search for" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a092b52e-bfda-4694-92a3-713b519ec2a1", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"accountId\": \"b3886346-4230-c1c7-15e6-c9f23bc4aa66\",\n \"bankDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"bankCountry\": {\n \"value\": \"\"\n },\n \"bic\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"bankCode\": {\n \"value\": \"\"\n },\n \"bankName\": {\n \"value\": \"\"\n },\n \"bankBranchName\": {\n \"value\": \"\"\n },\n \"bankAddress\": {\n \"value\": \"\"\n },\n \"bankCity\": {\n \"value\": \"\"\n },\n \"bankProvince\": {\n \"value\": \"\"\n },\n \"bankPostalCode\": {\n \"value\": \"\"\n },\n \"accountType\": {\n \"value\": \"\"\n },\n \"branchCode\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryStatus\": \"VERIFIED\",\n \"createdAt\": \"1954-08-24T08:35:53.704Z\",\n \"externalId\": \"string\",\n \"id\": \"6c60c467-8885-c014-7e62-4212bedb4738\",\n \"personalDetails\": {\n \"addressLine1\": {\n \"value\": \"\"\n },\n \"country\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"addressLine2\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"postalCode\": {\n \"value\": \"\"\n },\n \"phoneNumber\": {\n \"value\": \"\"\n },\n \"taxId\": {\n \"value\": \"\"\n },\n \"idNumber\": {\n \"value\": \"\"\n },\n \"contactName\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"accountId\": \"d2e102ea-e9ea-7640-ed19-7eb71f0811bd\",\n \"bankDetails\": {\n \"accountNumber\": {\n \"value\": \"\"\n },\n \"bankCountry\": {\n \"value\": \"\"\n },\n \"bic\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"bankCode\": {\n \"value\": \"\"\n },\n \"bankName\": {\n \"value\": \"\"\n },\n \"bankBranchName\": {\n \"value\": \"\"\n },\n \"bankAddress\": {\n \"value\": \"\"\n },\n \"bankCity\": {\n \"value\": \"\"\n },\n \"bankProvince\": {\n \"value\": \"\"\n },\n \"bankPostalCode\": {\n \"value\": \"\"\n },\n \"accountType\": {\n \"value\": \"\"\n },\n \"branchCode\": {\n \"value\": \"\"\n }\n },\n \"beneficiaryStatus\": \"VERIFIED\",\n \"createdAt\": \"1967-05-04T07:38:10.897Z\",\n \"externalId\": \"string\",\n \"id\": \"0f4c452d-2c79-a24e-a836-e3883f1839bc\",\n \"personalDetails\": {\n \"addressLine1\": {\n \"value\": \"\"\n },\n \"country\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"addressLine2\": {\n \"value\": \"\"\n },\n \"city\": {\n \"value\": \"\"\n },\n \"province\": {\n \"value\": \"\"\n },\n \"postalCode\": {\n \"value\": \"\"\n },\n \"phoneNumber\": {\n \"value\": \"\"\n },\n \"taxId\": {\n \"value\": \"\"\n },\n \"idNumber\": {\n \"value\": \"\"\n },\n \"contactName\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"page\": {\n \"size\": 9143,\n \"number\": 5436,\n \"totalElements\": 5324,\n \"totalPages\": 2577\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ccf6c37-05e6-46df-b824-081489fc961b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f16de245-c45c-4752-8382-69d5000cd95a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc020151-cb96-41da-bb3c-1bb1014752b3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb6ed54f-fd89-4ada-b5dd-7c45dc20aec7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea6b9e44-ee02-45aa-afcf-3ac2d7729cb6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc66784d-eb58-4d24-8e61-8595e45c1fca", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2fe9601-2da1-456c-880b-8ec078b5b20d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "beneficiaries", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b55ad9c8-a5c8-4a76-ba2c-bcdfa3861900", "name": "Transactions", "description": { "content": "Operations related to transactions", "type": "text/plain" }, "item": [ { "id": "4fa9508e-5125-41e2-b46b-4deb8c3b823c", "name": "Get all account transactions", "request": { "name": "Get all account transactions", "description": { "content": "Retrieve a paged list of all account transactions.", "type": "text/plain" }, "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "2af24968-f332-4798-935e-11a0dc5343a8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"externalId\": \"EXT123\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"shortId\": \"TR123\",\n \"status\": {\n \"state\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n },\n \"complete\": {\n \"value\": \"\"\n }\n },\n \"type\": \"DEPOSIT\",\n \"walletId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"deposit\": {\n \"senderAccountIdentifier\": {\n \"value\": \"\"\n },\n \"senderName\": {\n \"value\": \"\"\n },\n \"senderReference\": {\n \"value\": \"\"\n }\n },\n \"payment\": {\n \"beneficiaryAccountIdentifier\": {\n \"value\": \"\"\n },\n \"beneficiaryName\": {\n \"value\": \"\"\n },\n \"paymentReference\": {\n \"value\": \"\"\n }\n },\n \"exchange\": {\n \"from\": {\n \"value\": \"\"\n },\n \"rate\": {\n \"value\": \"\"\n },\n \"to\": {\n \"value\": \"\"\n }\n },\n \"charge\": {\n \"chargeForTransactionId\": {\n \"value\": \"\"\n }\n },\n \"completedAt\": \"2023-01-01T00:00:00Z\"\n },\n {\n \"amount\": {\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n }\n },\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"externalId\": \"EXT123\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"shortId\": \"TR123\",\n \"status\": {\n \"state\": {\n \"value\": \"\"\n },\n \"reason\": {\n \"value\": \"\"\n },\n \"complete\": {\n \"value\": \"\"\n }\n },\n \"type\": \"DEPOSIT\",\n \"walletId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"deposit\": {\n \"senderAccountIdentifier\": {\n \"value\": \"\"\n },\n \"senderName\": {\n \"value\": \"\"\n },\n \"senderReference\": {\n \"value\": \"\"\n }\n },\n \"payment\": {\n \"beneficiaryAccountIdentifier\": {\n \"value\": \"\"\n },\n \"beneficiaryName\": {\n \"value\": \"\"\n },\n \"paymentReference\": {\n \"value\": \"\"\n }\n },\n \"exchange\": {\n \"from\": {\n \"value\": \"\"\n },\n \"rate\": {\n \"value\": \"\"\n },\n \"to\": {\n \"value\": \"\"\n }\n },\n \"charge\": {\n \"chargeForTransactionId\": {\n \"value\": \"\"\n }\n },\n \"completedAt\": \"2023-01-01T00:00:00Z\"\n }\n ],\n \"page\": {\n \"size\": 9652,\n \"number\": 1310,\n \"totalElements\": 9303,\n \"totalPages\": 8877\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffdd95f2-be6c-4a9d-acec-f546efd52bb7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b93a032b-0b9b-4281-ac50-0345e6b24d50", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fb9699b-5dd2-4bb4-9a7f-24731f15f5ef", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e83940d-dbe6-4fd9-ac55-7b974b8e2205", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b352448-c484-4196-a4d3-64b3c294a013", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a639400b-fbeb-4c78-b336-557b68d3673a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3344a17-e35a-4a28-ba42-bbb5f91f7442", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "677186f2-7dbc-43ab-8274-81776838d4b1", "name": "Get a single transaction", "request": { "name": "Get a single transaction", "description": { "content": "Retrieve a single transaction by id", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "ab515cf9-efe7-4c8c-9f54-756f70eb3af3", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"amount\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"createdAt\": \"2023-01-01T00:00:00Z\",\n \"externalId\": \"EXT123\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"shortId\": \"TR123\",\n \"status\": {\n \"state\": \"PROCESSING\",\n \"reason\": \"LIMIT_REACHED\",\n \"complete\": true\n },\n \"type\": \"DEPOSIT\",\n \"walletId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"deposit\": {\n \"senderAccountIdentifier\": \"ACC123\",\n \"senderName\": \"John Doe\",\n \"senderReference\": \"REF123\"\n },\n \"payment\": {\n \"beneficiaryAccountIdentifier\": \"BEN123\",\n \"beneficiaryName\": \"Jane Doe\",\n \"paymentReference\": \"PAY123\"\n },\n \"exchange\": {\n \"from\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n },\n \"rate\": {\n \"currencyPair\": \"string\",\n \"price\": 1631.4211530177136,\n \"type\": \"OFFER\"\n },\n \"to\": {\n \"amount\": 100,\n \"currency\": \"USD\"\n }\n },\n \"charge\": {\n \"chargeForTransactionId\": \"CHG123\"\n },\n \"completedAt\": \"2023-01-01T00:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e215096-2d94-4963-aced-41ea6d8343c8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f002a8f6-f2a0-48c7-b8ce-82e01caee7f2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fa343d8-052d-4567-a1eb-a4cb16aee01a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7f04565-f1c7-4d42-8444-ac5753ce1824", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "430b6018-2861-4059-a57e-0d1303fc8347", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e881cd0-3b8a-4bcd-92e3-ab5be3ea35b0", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a63b8f4a-6bc1-4e0b-a417-7e6f1d037896", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "transactions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6af2e93b-a1ee-4574-8261-2fbac2b7f3cb", "name": "Account", "description": { "content": "Account creation and management", "type": "text/plain" }, "item": [ { "id": "c8518069-3d57-4b33-8cc8-4280caaf217d", "name": "Confirm account submission", "request": { "name": "Confirm account submission", "description": { "content": "Confirm that the account details and supporting document is ready for review and approval", "type": "text/plain" }, "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "830bdeaf-5f3a-4941-914d-3cbed5ea2c7d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountType\": \"INDIVIDUAL\",\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"accountStatus\": \"ACTIVE\",\n \"accountTier\": \"STARTER\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abb10727-a5b1-43dc-b85e-0367c12bc2db", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99dd5e55-fe4b-4215-834b-e477954ce927", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f41b15fb-2c99-4ca5-9a06-c5c9fd122469", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9360efe2-7d8d-4fdf-b738-104467b90180", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f85ffc5-295a-4d84-a774-73136928d340", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46e8ae1e-5ad1-44a9-a23d-b35ede118b02", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "557eea1f-081e-4143-95c2-7d6e05c8975d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d0885af-00fc-47c3-952f-90d45639440e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountTier\": \"STARTER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5cebe4d7-2178-4667-8ccd-3b3cc690d40d", "name": "Get account", "request": { "name": "Get account", "description": { "content": "Gets account summary", "type": "text/plain" }, "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a5e73c5c-8acb-451c-a9f1-c516a69bb9b9", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountType\": \"INDIVIDUAL\",\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"accountStatus\": \"ACTIVE\",\n \"accountTier\": \"STARTER\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a824e10e-6fa4-468e-a472-9faa37acbf20", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa85434b-7fc4-4736-91bd-2371653df382", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f3a7a8-2444-4de8-bc9e-dc60005802e1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28b5bfdc-7bf4-4c46-a6e3-164266c2ecf4", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2226a630-a82d-420e-a90c-87695c8fd5f2", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a758b4b7-9aaa-4807-a716-0ddce7c183c1", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63c2e653-5eb0-453b-8b52-ffb2165ba11b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cea2f29f-c7fa-48bc-992d-6d9258616448", "name": "Create account", "request": { "name": "Create account", "description": { "content": "Creates an account to onboard an entity with Hubpay", "type": "text/plain" }, "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f1ed1e6-8dc4-40e4-a237-bd353869408f", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountType\": \"INDIVIDUAL\",\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"accountStatus\": \"ACTIVE\",\n \"accountTier\": \"STARTER\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55812ba5-4de2-49e1-b4eb-d2743604342a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "659f687c-c9a6-453c-ae8c-a23a83765e55", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f742a1db-aca8-48f5-a3ae-aab91752e2b6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a5dc8c1-a42d-4488-bdca-85cfce86117a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0fb1e0d-b36d-40ae-8be4-dc57cc67d221", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dc1b8ed-304c-49ef-95c0-39b84a806381", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1660457c-8ed8-4173-840f-f46d61b0c7bc", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b3ae031-9a6d-4348-a104-4214ac7d1912", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b56c33b-7484-4c2c-bce2-e9fbb0e8b218", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"  uq8 
 CdI\",\n \"accountType\": \"INDIVIDUAL\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e36b600-da4f-46f3-b418-efae87e5bae8", "name": "Reject account (Sandbox)", "request": { "name": "Reject account (Sandbox)", "description": { "content": "**Non-production only.** Transitions the account to `DECLINED` and dispatches the\n`v1.onboarding.account.rejected` webhook. Can be called at any point in the\nonboarding flow.\n\nSee the [sandbox onboarding guide](/docs/guides/accounts/testing/simulating-onboarding).\n", "type": "text/plain" }, "url": { "path": [ "v1", "account", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "38473e51-0d52-4bca-a50a-739a55bcfd8d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountType\": \"INDIVIDUAL\",\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"accountStatus\": \"ACTIVE\",\n \"accountTier\": \"STARTER\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eb96b09-e196-4afa-a390-f05f2f8ede48", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50a5d9b9-b23c-449f-bc83-a4c50f452577", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6489f021-bf4f-4438-b946-ac98844ed769", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5513109-ffa8-4696-bd6c-b158fd656f33", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31ba1612-c3ab-477b-a57e-b15f10aec7a1", "name": "Approve account (Sandbox)", "request": { "name": "Approve account (Sandbox)", "description": { "content": "**Non-production only.** Transitions the account to `APPLICATION_APPROVED` and\ndispatches the `v1.onboarding.account.approved` webhook. The account must be in\n`APPLICATION_SUBMITTED` status. Call [confirm submission](/docs/guides/accounts/confirm-submission)\nfirst.\n\nSee the [sandbox onboarding guide](/docs/guides/accounts/testing/simulating-onboarding).\n", "type": "text/plain" }, "url": { "path": [ "v1", "account", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "6e007b6f-603e-447d-b326-990863715571", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountType\": \"INDIVIDUAL\",\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"accountStatus\": \"ACTIVE\",\n \"accountTier\": \"STARTER\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15bb7004-591c-43c3-b705-1fc38fc702cb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b318175c-afdc-4d1f-b46e-e09ef3e92b84", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce078b57-5c73-4f9a-ab27-1409646261a7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0c7e53c-b769-4f2e-b8f9-025102246eda", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15d0273b-1ab6-40be-8d12-013f6ba8d22e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98463d7e-960a-49f7-b576-14bd29876915", "name": "Get all accounts", "request": { "name": "Get all accounts", "description": { "content": "Get all accounts created by the partner", "type": "text/plain" }, "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "APPLICATION_SUBMITTED", "description": "Filter by account status" }, { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index" }, { "disabled": false, "key": "size", "value": "20", "description": "Page size (max 50)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "93c520f2-33e6-4f57-ad76-e76d8c075b69", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "APPLICATION_SUBMITTED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"accountType\": \"BUSINESS\",\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"accountStatus\": \"APPLICATION_IN_PROGRESS\",\n \"accountTier\": \"SCALE\"\n },\n {\n \"accountType\": \"BUSINESS\",\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"accountStatus\": \"APPLICATION_SUBMITTED\",\n \"accountTier\": \"STARTER\"\n }\n ],\n \"page\": {\n \"size\": 1108,\n \"number\": 1193,\n \"totalElements\": 6499,\n \"totalPages\": 2951\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba6fbd42-627c-42e1-a750-3d239ef13801", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "APPLICATION_SUBMITTED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8f7fe4f-5416-4b0c-b462-2bfea3632b23", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "APPLICATION_SUBMITTED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f93cc12-87a8-4cb1-89a6-ce8987f24720", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "APPLICATION_SUBMITTED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18caa325-aec3-4606-9693-30e7d55f710f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "APPLICATION_SUBMITTED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2fc2218-ffd7-4853-93c9-fa1bd5044100", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "APPLICATION_SUBMITTED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36ca66a3-791d-40b3-b266-43d326398c1f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "APPLICATION_SUBMITTED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "476b28f5-59e7-4827-98fe-2a0427e922f9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "APPLICATION_SUBMITTED" }, { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "90f3fcf0-682a-45a2-8fab-b9ce28ebe7ca", "name": "Business Profile", "description": { "content": "Business profile management", "type": "text/plain" }, "item": [ { "id": "11453c4c-caf4-46d7-991c-91d810b716aa", "name": "Get business profile", "request": { "name": "Get business profile", "description": { "content": "For business accounts only - retrieves the business profile.", "type": "text/plain" }, "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "d34143e8-269a-425a-a102-1891f4b4af26", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountName\": \"string\",\n \"countryOfRegistration\": \"string\",\n \"industries\": [\n \"CHEMICALS_PETROCHEMICALS_AND_PETROLEUM_PRODUCTS\",\n \"SECURITIES_AND_COMMODITY_EXCHANGES\"\n ],\n \"legalType\": \"GENERAL_PARTNERSHIP_COMPANY\",\n \"incorporatedInUae\": true,\n \"hasBankAccount\": false,\n \"yearsOfBusinessRange\": \"FIVE_PLUS\",\n \"numberOfEmployeesRange\": \"THIRTY_PLUS\",\n \"annualRevenue\": 8285,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"IN_PERSON\",\n \"salesDistributionChannels\": [\n \"DIGITAL_ADVERTISING\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"PERSONAL\"\n },\n \"incomingPaymentCountries\": [\n \"string\",\n \"string\"\n ],\n \"incomingPaymentsMonthlyVolume\": 8057,\n \"incomingPaymentsMonthlyCount\": 1930,\n \"outgoingPaymentCountries\": [\n \"string\",\n \"string\"\n ],\n \"outgoingPaymentsMonthlyVolume\": 4902,\n \"outgoingPaymentsMonthlyCount\": 4604,\n \"accountOpeningPurposes\": [\n \"BULK_PAYMENTS\",\n \"SEND_FUNDS\"\n ],\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"string\",\n \"postalCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1fb2dab-bfa7-4c39-aa07-6b28330a9a5d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e130bc4-4e18-4650-92df-6c0687456b06", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6adfd285-ad32-4f62-a61c-bc485da45987", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee80f06f-fe52-447f-873c-f25e9eada75e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae00726f-77e2-44e6-a4e5-dfca093ae6e9", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "856416ff-5250-44fa-bc4b-66d15a55ab78", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b349fab4-8a27-4661-acd7-229b40847c23", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b9fa270-6b62-49d1-9d81-70fec258170b", "name": "Update business profile", "request": { "name": "Update business profile", "description": { "content": "For business accounts only - updates the business profile", "type": "text/plain" }, "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\\r W \",\n \"accountOpeningPurposes\": [\n \"SEND_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": false,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 7556,\n \"incomingPaymentsMonthlyVolume\": 1767,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"FURNITURE_STORES_AND_MANUFACTURING\"\n ],\n \"legalType\": \"GENERAL_PARTNERSHIP_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 2480,\n \"outgoingPaymentsMonthlyVolume\": 6566,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 1355,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"ONLINE\",\n \"salesDistributionChannels\": [\n \"SOCIAL_MEDIA\",\n \"TRADE_SHOWS\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"PERSONAL\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"string\",\n \"postalCode\": \"string\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f7ca1474-245a-42f1-bfca-87350db8b48a", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountType\": \"INDIVIDUAL\",\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"countryCode\": \"GB\",\n \"externalId\": \"string\",\n \"accountStatus\": \"ACTIVE\",\n \"accountTier\": \"STARTER\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b106e312-9115-4e66-8ede-14772d30f525", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47ccb897-bfd9-499c-baf0-b124e361e9a2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1342143-58ed-4fa6-9470-eab0b950b48c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49dc570d-8aa9-4e25-b0c0-f7a80bb792f5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a92dab6-bff6-49a8-b4f2-af37d7167fd0", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "163d3ad3-bfaf-469f-911e-81e9fe3bf184", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bbd692d-7555-4858-a67a-32ade818033d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b2d6d67-ffee-4fc4-9d59-fa20f470bed4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "business-profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"accountName\": \"Uuf\",\n \"accountOpeningPurposes\": [\n \"RECEIVE_FUNDS\"\n ],\n \"countryOfRegistration\": \"AE\",\n \"hasBankAccount\": true,\n \"incomingPaymentCountries\": [\n \"string\"\n ],\n \"incomingPaymentsMonthlyCount\": 6662,\n \"incomingPaymentsMonthlyVolume\": 1268,\n \"incorporatedInUae\": false,\n \"industries\": [\n \"VIDEO_AND_TELECONFERENCING\"\n ],\n \"legalType\": \"LIMITED_LIABILITY_COMPANY\",\n \"numberOfEmployeesRange\": \"ONE_TO_TEN\",\n \"outgoingPaymentCountries\": [\n \"string\"\n ],\n \"outgoingPaymentsMonthlyCount\": 10,\n \"outgoingPaymentsMonthlyVolume\": 9812,\n \"yearsOfBusinessRange\": \"ONE_TO_TWO\",\n \"annualRevenue\": 4549,\n \"website\": \"string\",\n \"productOrServiceSold\": \"string\",\n \"intendedSalesChannel\": \"BOTH\",\n \"salesDistributionChannels\": [\n \"IN_PERSON_SALES_TEAM\",\n \"SOCIAL_MEDIA\"\n ],\n \"investmentSourceOfFunds\": {\n \"description\": \"string\",\n \"type\": \"OTHER\"\n },\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceState\": \"s\",\n \"postalCode\": \"stri\",\n \"dateOfIncorporation\": \"2023-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2fe8f6db-fdc6-4676-9dde-e25f75d57507", "name": "Branding", "description": { "content": "Account branding configuration", "type": "text/plain" }, "item": [ { "id": "5fd61888-ffea-4fb7-8c87-d3c06778bcdd", "name": "Get account brand settings", "request": { "name": "Get account brand settings", "description": { "content": "Retrieves the branding configuration.", "type": "text/plain" }, "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "fa9c97a0-fb4e-4ca0-aca6-43ab7fc3ec5e", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"primaryColor\": \"#123456\",\n \"secondaryColor\": \"#abcdef\",\n \"logoUrl\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "656f9b9b-d397-4bb5-b3b1-04076df40bf3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a7a563b-e91e-49db-8b7f-2b29a36856bf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9214f140-a249-47ab-aa7d-efbe20f1bd41", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81e8f2bf-cdc8-4518-ab35-9fb10ec1041b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee5c9585-e51e-4cce-a3f3-208a7b5dece5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b53070ae-266e-4f7d-ad3b-1f4a6de5672b", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c33f2c0a-581a-48f9-bed2-302a4100b957", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab38354e-9424-4f4e-8db1-9d9379f4bb36", "name": "Update account brand settings", "request": { "name": "Update account brand settings", "description": { "content": "Updates the branding configuration.\nAll fields are optional. Any field supplied in the request will be applied.\nThis endpoint supports multipart/form-data for file upload and text parameters.\n", "type": "text/plain" }, "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "key": "primaryColor", "value": "#123456", "type": "text", "description": "Primary branding color in hex format" }, { "key": "secondaryColor", "value": "#abcdef", "type": "text", "description": "Secondary branding color in hex format" }, { "key": "logo", "type": "file", "description": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB." } ] } }, "response": [ { "id": "3908f5a4-3da3-4f6b-9d53-ff02b6729af3", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"primaryColor\": \"#123456\",\n \"secondaryColor\": \"#abcdef\",\n \"logoUrl\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aae126b6-bc20-4677-bb83-c42f7060d5b3", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f1ddf02-2f57-4134-a9cc-5ccb1914f2ed", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a3d33d3-cf57-41d1-9fab-de248477ba43", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fcd3070-780c-48c1-a9cf-bb17767f94c7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42d963f2-6659-4aa9-95c1-676b64775fcc", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "380c4c68-b229-4b18-af7b-ddaf931f796d", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e2d6616-55b1-47fe-ab8d-5c19c7a3b89e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28f1749a-f0eb-442a-9df8-ee07a8a736f1", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "branding" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Primary branding color in hex format", "type": "text/plain" }, "key": "primaryColor", "value": "#123456", "type": "text" }, { "description": { "content": "Secondary branding color in hex format", "type": "text/plain" }, "key": "secondaryColor", "value": "#abcdef", "type": "text" }, { "description": { "content": "Logo file to be displayed during payment. Must be JPG or PNG format, at least 128x128 pixels, and no larger than 512KB.", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5c21716-5373-4528-ba5a-e56eab36eae4", "name": "Reset account brand settings", "request": { "name": "Reset account brand settings", "description": { "content": "Resets all branding settings (primary color, secondary color, and logo) to defaults.", "type": "text/plain" }, "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT" }, "response": [ { "id": "f3df5bcf-12d5-49f0-934b-b0c62addb605", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dfa1c9cd-9d42-49c3-9703-bc9f18d0c547", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ceae6cb-5988-4dca-99f6-6db06ad2e9de", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ab3abde-01fc-4e7f-a6e2-72a636542405", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4eaa2ff-7f9f-4a6d-bf19-6283cfe8c561", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e0d889e-89c1-440d-8e51-f320a44d3354", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db6f7ba4-3d23-4649-ba0b-a2200049f345", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42d1ece6-26ff-400d-acf8-25c39c1c0dc6", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5faa992-65a3-4066-94a9-2da035ef39ac", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "branding", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "37c24d1c-7c02-4ce2-8f57-7a5364b261b6", "name": "Persons", "description": { "content": "Related persons management", "type": "text/plain" }, "item": [ { "id": "a1ec003e-71d8-46fa-8495-5ecdae6c2e7d", "name": "Get person", "request": { "name": "Get person", "description": { "content": "For business accounts - get details of a Shareholder, Director or Authorised Signatory", "type": "text/plain" }, "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "89be339c-00aa-4959-9197-fe9527aacd74", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"authorizedSignatory\": true,\n \"director\": false,\n \"documents\": [\n {\n \"description\": \"string\",\n \"documentType\": \"RESIDING_COUNTRY_PROOF_OF_ADDRESS\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"669357e9-5b1f-aacf-fdc5-eb4bbb8c6c16\",\n \"required\": true,\n \"status\": \"NOT_SUBMITTED\",\n \"title\": \"string\",\n \"expiresAt\": \"1997-04-21T15:57:20.247Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_QUALITY_INSUFFICIENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1963-08-06T10:48:51.794Z\"\n },\n {\n \"description\": \"string\",\n \"documentType\": \"EMIRATES_ID\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"5a35ed8d-67ef-edab-aa54-9c87d79724b2\",\n \"required\": true,\n \"status\": \"PENDING_VERIFICATION\",\n \"title\": \"string\",\n \"expiresAt\": \"2000-08-03T08:31:32.246Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_REQUIRED_FIELDS_MISSING\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1982-10-02T01:30:57.040Z\"\n }\n ],\n \"fullNameAsPerId\": \"string\",\n \"id\": \"d2074ccd-995e-a578-62c0-08102513254b\",\n \"shareholder\": false,\n \"status\": \"APPROVED\",\n \"uaeResident\": false,\n \"linkedInProfileUrl\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cab06da-8e71-455a-b568-fef6cf139842", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f65694b5-cbc8-479e-8149-e286180572d9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47e119e9-2bdd-4772-bd2a-cdfd40c5a0ae", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "408b2c91-2637-4cf2-b72b-15520c3928ea", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0df6263-20bb-4483-955e-549d524057fa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbbf5443-7546-456b-baef-dd00f09fdbab", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df7b8e81-152f-456e-a2b7-314fc308f01f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3674726-cfda-4bfa-a06b-d7fc40789728", "name": "Update person", "request": { "name": "Update person", "description": { "content": "For business accounts - update details of Shareholders, Directors and Authorised Signatories
  • Shareholders: Individuals who hold shares in the company
  • Directors: People legally responsible for managing the company's operations and decision-making
  • Authorised Signatories: Individuals who have the authority to sign documents and make official commitments on behalf of the company
", "type": "text/plain" }, "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b2ad9224-280b-4481-a7f2-7350ddf68e82", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"authorizedSignatory\": true,\n \"director\": false,\n \"documents\": [\n {\n \"description\": \"string\",\n \"documentType\": \"RESIDING_COUNTRY_PROOF_OF_ADDRESS\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"669357e9-5b1f-aacf-fdc5-eb4bbb8c6c16\",\n \"required\": true,\n \"status\": \"NOT_SUBMITTED\",\n \"title\": \"string\",\n \"expiresAt\": \"1997-04-21T15:57:20.247Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_QUALITY_INSUFFICIENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1963-08-06T10:48:51.794Z\"\n },\n {\n \"description\": \"string\",\n \"documentType\": \"EMIRATES_ID\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"5a35ed8d-67ef-edab-aa54-9c87d79724b2\",\n \"required\": true,\n \"status\": \"PENDING_VERIFICATION\",\n \"title\": \"string\",\n \"expiresAt\": \"2000-08-03T08:31:32.246Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_REQUIRED_FIELDS_MISSING\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1982-10-02T01:30:57.040Z\"\n }\n ],\n \"fullNameAsPerId\": \"string\",\n \"id\": \"d2074ccd-995e-a578-62c0-08102513254b\",\n \"shareholder\": false,\n \"status\": \"APPROVED\",\n \"uaeResident\": false,\n \"linkedInProfileUrl\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dc0e07b-74eb-4e8c-ac2b-d473510c0a1a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1326f52f-4470-4cfd-8859-b26ef50b0bb3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9d4bc45-ecae-4211-9b73-95fd2fdc626e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4c1dd9c-62d8-4cc9-9e58-f8c381b57980", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3ee4236-3a49-4fbe-a0e2-583fe0dda8eb", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "246c314e-e597-443c-a167-c18b3113eb3a", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9875c92f-0167-433f-aa0e-39e7eea2252d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3b4b48f-72ad-44f6-ad00-757b25e73191", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons", ":personId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "personId", "description": "(Required) Unique identifier of the related person" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "249bee23-7677-4011-bdc1-af3f4627bd4c", "name": "Get all persons", "request": { "name": "Get all persons", "description": { "content": "Get all persons related to the business account", "type": "text/plain" }, "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index" }, { "disabled": false, "key": "size", "value": "20", "description": "Page size" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "af09c50c-28e9-4c12-9087-a3515d72289d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"authorizedSignatory\": true,\n \"director\": false,\n \"documents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"fullNameAsPerId\": \"string\",\n \"id\": \"34fd018d-f6c4-0c08-fa64-825879eab48d\",\n \"shareholder\": false,\n \"status\": \"NOT_SUBMITTED\",\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"string\"\n },\n {\n \"authorizedSignatory\": false,\n \"director\": false,\n \"documents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"fullNameAsPerId\": \"string\",\n \"id\": \"b0172143-9554-2f8a-6bf4-c9ea4933a151\",\n \"shareholder\": false,\n \"status\": \"ACTION_REQUIRED\",\n \"uaeResident\": false,\n \"linkedInProfileUrl\": \"string\"\n }\n ],\n \"page\": {\n \"size\": 3279,\n \"number\": 335,\n \"totalElements\": 647,\n \"totalPages\": 1286\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fbe878d-f4c0-41c1-a35f-586bfccc6a22", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f40d19fa-fc8e-4bde-897e-0e5f7ee01a4c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3ca5740-c4da-42aa-8f36-8614d00b8d9b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96e95625-65ac-4851-bb00-3be59b0707ca", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb6ee9fa-276b-4410-ad94-1e7644d18377", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "976cc243-f9ad-4a86-93cf-30ff7499eb8c", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86b5a624-b0e0-4342-b7a1-1fe77126dbe9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe79a140-0671-4193-ba53-baf366758f59", "name": "Add person", "request": { "name": "Add person", "description": { "content": "For business accounts - add details of Shareholders, Directors and Authorised Signatories
  • Shareholders: Individuals who hold shares in the company
  • Directors: People legally responsible for managing the company's operations and decision-making
  • Authorised Signatories: Individuals who have the authority to sign documents and make official commitments on behalf of the company
", "type": "text/plain" }, "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c2fe008a-32ed-4ab2-9fa6-c7b1e208f822", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"authorizedSignatory\": true,\n \"director\": false,\n \"documents\": [\n {\n \"description\": \"string\",\n \"documentType\": \"RESIDING_COUNTRY_PROOF_OF_ADDRESS\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"669357e9-5b1f-aacf-fdc5-eb4bbb8c6c16\",\n \"required\": true,\n \"status\": \"NOT_SUBMITTED\",\n \"title\": \"string\",\n \"expiresAt\": \"1997-04-21T15:57:20.247Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_QUALITY_INSUFFICIENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1963-08-06T10:48:51.794Z\"\n },\n {\n \"description\": \"string\",\n \"documentType\": \"EMIRATES_ID\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"5a35ed8d-67ef-edab-aa54-9c87d79724b2\",\n \"required\": true,\n \"status\": \"PENDING_VERIFICATION\",\n \"title\": \"string\",\n \"expiresAt\": \"2000-08-03T08:31:32.246Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_REQUIRED_FIELDS_MISSING\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1982-10-02T01:30:57.040Z\"\n }\n ],\n \"fullNameAsPerId\": \"string\",\n \"id\": \"d2074ccd-995e-a578-62c0-08102513254b\",\n \"shareholder\": false,\n \"status\": \"APPROVED\",\n \"uaeResident\": false,\n \"linkedInProfileUrl\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25820339-a474-400e-99a3-b7d213cca616", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65f32073-4dd3-4d2a-8494-aa2b3f219ed7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38f10c7e-c6dd-4f7e-86a5-5afdd3ce74d2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d0e7981-fb03-4c3c-98a5-4e5984f71a46", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e748976a-eabe-4835-a472-cd5dfc726f4f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dc72b16-bd9a-4ed3-8e47-950066aaec84", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e93cbd4-1007-4437-b6b4-ffe6dbe1fb32", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a00f272e-a3d4-4c72-9f04-2090fe1c2293", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b5ea6f-9a0d-4f22-ad87-cf19c08f1f98", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "persons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"f8e202c3-942c-a0f8-6343-03cda343d414\"\n ],\n \"type\": \"BANK_STATEMENT\"\n }\n ],\n \"authorizedSignatory\": true,\n \"director\": false,\n \"fullNameAsPerId\": \"string\",\n \"shareholder\": true,\n \"uaeResident\": true,\n \"linkedInProfileUrl\": \"linkedin.com/in/BYu4/Rzb\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3f6fddca-0377-4b49-88a0-034720b3ff14", "name": "Corporates", "description": { "content": "Related corporate entity management", "type": "text/plain" }, "item": [ { "id": "6db7c178-9a6e-47ae-ae42-19e4409f466e", "name": "Get corporate", "request": { "name": "Get corporate", "description": { "content": "Get details of a specific corporate entity related to the business account", "type": "text/plain" }, "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "02c8f217-5cc2-4c02-868b-9bb3fb136807", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"createdAt\": \"1993-04-11T05:50:15.468Z\",\n \"documents\": [\n {\n \"description\": \"string\",\n \"documentType\": \"SHAREHOLDING_CERTIFICATE\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"bc76feb9-82f8-0372-b8bb-cfe99fe41541\",\n \"required\": false,\n \"status\": \"APPROVED\",\n \"title\": \"string\",\n \"expiresAt\": \"1971-04-08T08:37:23.128Z\",\n \"declinedReason\": \"INVALID_DOCUMENT_TYPE\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_QUALITY_INSUFFICIENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"2013-08-14T20:08:50.624Z\"\n },\n {\n \"description\": \"string\",\n \"documentType\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"fed607f4-6bf3-9c5f-8fa1-af5d1400e024\",\n \"required\": false,\n \"status\": \"NOT_SUBMITTED\",\n \"title\": \"string\",\n \"expiresAt\": \"1972-03-24T16:03:24.869Z\",\n \"declinedReason\": \"NOT_CERTIFIED\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_EXPIRING_DOCUMENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1999-04-20T04:33:31.897Z\"\n }\n ],\n \"id\": \"775eb7e3-eaa8-cb49-00a7-fb3a9d2572af\",\n \"name\": \"string\",\n \"percentageOwned\": 1766.4414831371532,\n \"relationship\": \"PARENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41072e50-be19-4915-b5dd-01649347f780", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5dcc592-9e7f-4fe0-b566-4cb656b0baf8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01074c44-6e4f-4ff7-ae25-35e4e14f6106", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65d9aff6-8940-4bd9-9af2-5e9521e44c3e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "781d1c27-9cb3-43e1-9a22-30ffae07b551", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e310dd82-7b06-4780-8037-45966016bdd5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "318f9787-46ce-4a8d-aa30-e022989df5cd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66ec4b99-6a4f-4a08-b044-09cff0e9a49a", "name": "Update corporate", "request": { "name": "Update corporate", "description": { "content": "Update details of a corporate entity related to the business account.
  • Parent: A company that owns or controls the business being onboarded
  • Subsidiary: A company that is owned or controlled by the business being onboarded
", "type": "text/plain" }, "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"u\\tCX\",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 71.40111435674538,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"15e21182-820b-a2a9-5266-4d0563d73679\"\n ],\n \"type\": \"TRADE_LICENSE\"\n },\n {\n \"documentIds\": [\n \"b4858452-22f5-8387-43b2-50c7b5e7142e\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "81e810e2-d8e0-4125-806a-04013742d95d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"createdAt\": \"1993-04-11T05:50:15.468Z\",\n \"documents\": [\n {\n \"description\": \"string\",\n \"documentType\": \"SHAREHOLDING_CERTIFICATE\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"bc76feb9-82f8-0372-b8bb-cfe99fe41541\",\n \"required\": false,\n \"status\": \"APPROVED\",\n \"title\": \"string\",\n \"expiresAt\": \"1971-04-08T08:37:23.128Z\",\n \"declinedReason\": \"INVALID_DOCUMENT_TYPE\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_QUALITY_INSUFFICIENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"2013-08-14T20:08:50.624Z\"\n },\n {\n \"description\": \"string\",\n \"documentType\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"fed607f4-6bf3-9c5f-8fa1-af5d1400e024\",\n \"required\": false,\n \"status\": \"NOT_SUBMITTED\",\n \"title\": \"string\",\n \"expiresAt\": \"1972-03-24T16:03:24.869Z\",\n \"declinedReason\": \"NOT_CERTIFIED\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_EXPIRING_DOCUMENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1999-04-20T04:33:31.897Z\"\n }\n ],\n \"id\": \"775eb7e3-eaa8-cb49-00a7-fb3a9d2572af\",\n \"name\": \"string\",\n \"percentageOwned\": 1766.4414831371532,\n \"relationship\": \"PARENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3b3b24e-c278-45b3-8ccb-b0e6bccf56bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36c3a44f-bc82-44a6-8a56-5266df7e22f9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b007a474-11ff-49f1-9e36-92d07e7fc8a3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecd3c715-9c6e-4b01-a6be-927acafa1133", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e85de2a-2dc3-4070-a866-35ad14f1830f", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f886fee3-2e3b-46fe-b0ac-4b7d00c24bc8", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5454952-9e5f-45a8-9581-508f9cd5fc82", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8c268d2-82ca-422c-8858-44ae6aad6f10", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates", ":corporateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "corporateId", "description": "(Required) Unique identifier of the related corporate entity" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6c5ab91-31fa-4f95-8ae9-2bb448c0b725", "name": "Get all corporates", "request": { "name": "Get all corporates", "description": { "content": "Get all corporate entities related to the business account", "type": "text/plain" }, "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index" }, { "disabled": false, "key": "size", "value": "20", "description": "Page size" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "eab99462-b690-423a-866e-dfe6791f786b", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"createdAt\": \"2009-05-28T08:12:56.803Z\",\n \"documents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"c59c6c1d-7514-539b-d968-80ba11d450dd\",\n \"name\": \"string\",\n \"percentageOwned\": 9805.869208674276,\n \"relationship\": \"SUBSIDIARY\"\n },\n {\n \"createdAt\": \"1972-10-16T13:16:57.579Z\",\n \"documents\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"5f02c513-2c89-848d-34f3-db11620cf07d\",\n \"name\": \"string\",\n \"percentageOwned\": 3647.0487566281686,\n \"relationship\": \"SUBSIDIARY\"\n }\n ],\n \"page\": {\n \"size\": 4206,\n \"number\": 5628,\n \"totalElements\": 5727,\n \"totalPages\": 6631\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afae7090-5769-4df6-b478-a6065fd1e886", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1de5e00-412a-4ffa-9554-b2381591865e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07c1dcfc-074f-4298-bcdf-5f1d97e726dd", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60a1067a-ac54-4b9f-a30b-f4911e79763e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9f6062c-2755-46e7-bf54-42cb1b0d910b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99084d43-d3ed-4276-9aa4-1f8553d71f8b", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffaac8a5-1d3f-47bf-b6b7-b4e898cd7fc9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "900489c3-0238-4d2a-b75f-0bcdf849477a", "name": "Add corporate", "request": { "name": "Add corporate", "description": { "content": "Add a corporate entity related to the business account.
  • Parent: A company that owns or controls the business being onboarded
  • Subsidiary: A company that is owned or controlled by the business being onboarded
", "type": "text/plain" }, "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"u\\tCX\",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 71.40111435674538,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"15e21182-820b-a2a9-5266-4d0563d73679\"\n ],\n \"type\": \"TRADE_LICENSE\"\n },\n {\n \"documentIds\": [\n \"b4858452-22f5-8387-43b2-50c7b5e7142e\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e06e8c6a-0fd3-41d6-b06b-5cbea48b752d", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"createdAt\": \"1993-04-11T05:50:15.468Z\",\n \"documents\": [\n {\n \"description\": \"string\",\n \"documentType\": \"SHAREHOLDING_CERTIFICATE\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"bc76feb9-82f8-0372-b8bb-cfe99fe41541\",\n \"required\": false,\n \"status\": \"APPROVED\",\n \"title\": \"string\",\n \"expiresAt\": \"1971-04-08T08:37:23.128Z\",\n \"declinedReason\": \"INVALID_DOCUMENT_TYPE\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_QUALITY_INSUFFICIENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"2013-08-14T20:08:50.624Z\"\n },\n {\n \"description\": \"string\",\n \"documentType\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"fed607f4-6bf3-9c5f-8fa1-af5d1400e024\",\n \"required\": false,\n \"status\": \"NOT_SUBMITTED\",\n \"title\": \"string\",\n \"expiresAt\": \"1972-03-24T16:03:24.869Z\",\n \"declinedReason\": \"NOT_CERTIFIED\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_EXPIRING_DOCUMENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1999-04-20T04:33:31.897Z\"\n }\n ],\n \"id\": \"775eb7e3-eaa8-cb49-00a7-fb3a9d2572af\",\n \"name\": \"string\",\n \"percentageOwned\": 1766.4414831371532,\n \"relationship\": \"PARENT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78c418a4-0a9f-4008-88b1-4afc70598b9b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd3c7530-588f-490f-93eb-38303dddecd9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dfff010-0ca9-4ae8-894a-7b720985b179", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f9b00fb-df6c-412b-ad90-bc8a35d6c654", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45bc4dc4-6e54-4341-a4f5-a402ca58b11a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcd867ac-de82-4fd7-a3fa-598a1d282625", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31c56e03-7ab3-48ee-b39c-43f5da18ba39", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e7e678a-bd1d-4160-8ffa-26923d942e38", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f7ccf9e-966f-4e21-a2a4-4eb18fe498dd", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "related-party", "corporates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"7Kzd \",\n \"relationship\": \"PARENT\",\n \"sharePercentageOwned\": 5.310933861667572,\n \"attachedDocuments\": [\n {\n \"documentIds\": [\n \"dc18bad9-8506-e2c0-de50-54e86e68f1f6\"\n ],\n \"type\": \"MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION\"\n },\n {\n \"documentIds\": [\n \"8fd95157-ba01-9d55-5331-165e0064556f\"\n ],\n \"type\": \"TRADE_LICENSE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4d008f16-67a6-4664-ba7b-716f3aadd3e3", "name": "Documents", "description": { "content": "Document management", "type": "text/plain" }, "item": [ { "id": "be8143e0-c9f8-4e53-b4fc-728206fc9045", "name": "Get all account documents", "request": { "name": "Get all account documents", "description": { "content": "Get submitted documents and their status", "type": "text/plain" }, "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "550a252e-82f8-4fe0-a311-059a958b7d2c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountDocuments\": [\n {\n \"description\": \"string\",\n \"documentType\": \"LATEST_AUDITED_FINANCIAL_STATEMENTS\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"6658e6a2-6ff3-9582-454b-3c59103cdf25\",\n \"required\": true,\n \"status\": \"APPROVED\",\n \"title\": \"string\",\n \"expiresAt\": \"1985-07-08T15:48:07.826Z\",\n \"declinedReason\": \"INVALID_DOCUMENT_TYPE\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_REQUIRED_FIELDS_MISSING\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"2004-11-30T01:36:17.280Z\"\n },\n {\n \"description\": \"string\",\n \"documentType\": \"LATEST_AUDITED_FINANCIAL_STATEMENTS\",\n \"documentUploads\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"id\": \"52884805-62ca-a5af-9957-f9d51bcf5c86\",\n \"required\": false,\n \"status\": \"VALIDATION_WARNINGS\",\n \"title\": \"string\",\n \"expiresAt\": \"2000-12-20T16:20:29.001Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_REQUIRED_FIELDS_MISSING\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1975-08-18T16:41:21.435Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bf2bcfa-2d9a-4897-98aa-a34df234d78b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d02d4fa3-e9f3-418a-8618-62fec5c0b9b6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11ab9987-9858-4aff-85ff-db3fcdbe96a8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "566457ee-5218-4a3c-b6e9-aa0abe4f072b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "912974fd-5adc-4ce0-b5d9-a224cac5233d", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf528f13-a31f-455f-9409-383ac3f84b4d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8027a91e-cfb1-450c-aa15-d3ebd0ae3b5b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9417b35-81cd-4e6d-9ed4-1a6a1392f710", "name": "Add/update document", "request": { "name": "Add/update document", "description": { "content": "Add/update a document by type. If the document already exists, it will be updated with the new file. If the document does not exist, it will be created.", "type": "text/plain" }, "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0c7c7b14-b534-459a-b075-4885fdbc23f9", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"documentType\": \"LATEST_AUDITED_FINANCIAL_STATEMENTS\",\n \"documentUploads\": [\n {\n \"contentType\": \"string\",\n \"createdAt\": \"2012-06-18T18:33:28.148Z\",\n \"fileName\": \"string\",\n \"id\": \"b76730b5-f05e-4efa-c090-bfe218bf680e\"\n },\n {\n \"contentType\": \"string\",\n \"createdAt\": \"1969-01-21T00:57:44.756Z\",\n \"fileName\": \"string\",\n \"id\": \"d8af84a9-8d21-b0f5-ff24-25b3c5ebf16c\"\n }\n ],\n \"id\": \"89a94340-2ce8-173d-075f-b127d75d2c53\",\n \"required\": false,\n \"status\": \"NOT_SUBMITTED\",\n \"title\": \"string\",\n \"expiresAt\": \"1990-09-06T04:41:21.614Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"CRITICAL_OTHER\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1979-02-28T21:12:53.757Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5ed59ec-d20f-4e54-b623-8f2c00d7db2e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa5987fd-02de-4355-8920-84a92cfe4743", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16186410-4d4a-4356-8cf8-3be07023db8f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "289687be-9db6-4aca-bafb-1b01fa33519e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a56bc54-acd9-4292-aba4-582f0602c728", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f51c1131-76ab-469c-8fd1-a90e15cf631b", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd3feca3-ff97-464f-b142-77b753020c38", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c834da03-9a77-45ec-b4f6-b56b1c07e5f5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d92b83eb-5799-4f40-85e5-d29d5903291c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"documentType\": \"BANK_STATEMENT\",\n \"documentUploadIds\": [\n \"cb07a110-9ef9-be95-dec8-c3eb53a3c968\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae63d612-dbd6-457f-a5dc-0d949b0737af", "name": "Decline document (Sandbox)", "request": { "name": "Decline document (Sandbox)", "description": { "content": "**Non-production only.** Marks the KYB onboarding document as `DECLINED` and\ndispatches the `v1.onboarding.document.declined` webhook.\n\nSee the [sandbox onboarding guide](/docs/guides/accounts/testing/simulating-onboarding).\n", "type": "text/plain" }, "url": { "path": [ "v1", "account", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a9f0be41-3ac2-5514-24b3-8fd711b4f0ee", "key": "documentId", "description": "(Required) ID of the document to decline" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "d9015890-bd51-4895-b566-27195a2cbd10", "name": "Document declined; the corresponding webhook has been dispatched.", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a9f0be41-3ac2-5514-24b3-8fd711b4f0ee", "key": "documentId", "description": "(Required) ID of the document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5fef79a-b05e-4924-9744-4d5a3861d0f9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a9f0be41-3ac2-5514-24b3-8fd711b4f0ee", "key": "documentId", "description": "(Required) ID of the document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5e42aa0-52bf-4061-8b65-551aaef9b7c7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a9f0be41-3ac2-5514-24b3-8fd711b4f0ee", "key": "documentId", "description": "(Required) ID of the document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01987e2d-0843-491d-8256-5e5b4e31055c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a9f0be41-3ac2-5514-24b3-8fd711b4f0ee", "key": "documentId", "description": "(Required) ID of the document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6afdf83-f094-4d14-b5e5-87099e2b090e", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a9f0be41-3ac2-5514-24b3-8fd711b4f0ee", "key": "documentId", "description": "(Required) ID of the document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff917d42-0c34-4f0b-ac58-54fc411d2c8e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a9f0be41-3ac2-5514-24b3-8fd711b4f0ee", "key": "documentId", "description": "(Required) ID of the document to decline" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "519e96f5-07df-4391-a1f3-9c64704658db", "name": "Approve document (Sandbox)", "request": { "name": "Approve document (Sandbox)", "description": { "content": "**Non-production only.** Marks the KYB onboarding document as `APPROVED` and\ndispatches the `v1.onboarding.document.approved` webhook.\n\nSee the [sandbox onboarding guide](/docs/guides/accounts/testing/simulating-onboarding).\n", "type": "text/plain" }, "url": { "path": [ "v1", "account", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "baa1fae3-840f-827d-db4a-a596142aa13c", "key": "documentId", "description": "(Required) ID of the document to approve" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "7149dfad-5ec3-403c-b05a-0497ae545f90", "name": "Document approved; the corresponding webhook has been dispatched.", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "baa1fae3-840f-827d-db4a-a596142aa13c", "key": "documentId", "description": "(Required) ID of the document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d17788b-e613-4561-a98f-bc429e1032e6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "baa1fae3-840f-827d-db4a-a596142aa13c", "key": "documentId", "description": "(Required) ID of the document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "707aca6c-79c1-483d-92e0-83b1dcce7d87", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "baa1fae3-840f-827d-db4a-a596142aa13c", "key": "documentId", "description": "(Required) ID of the document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab6126a4-ebb6-4678-9e91-0c7260d0034c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "baa1fae3-840f-827d-db4a-a596142aa13c", "key": "documentId", "description": "(Required) ID of the document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "077c28f1-eeaa-4409-9ee6-77026789353e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "baa1fae3-840f-827d-db4a-a596142aa13c", "key": "documentId", "description": "(Required) ID of the document to approve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2203f89f-ffb0-498d-9e97-68ef4b817016", "name": "Acknowledge document validation warnings", "request": { "name": "Acknowledge document validation warnings", "description": { "content": "Acknowledges validation warnings on a document and moves it to manual review. The document must be in **VALIDATION_WARNINGS** status. Use this when the customer has reviewed the automated warning and confirms the document is correct.", "type": "text/plain" }, "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "c973c71b-099f-4a26-b6bb-3e4f5ac76e02", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"documentUploads\": [\n {\n \"contentType\": \"string\",\n \"createdAt\": \"1985-03-28T12:16:36.863Z\",\n \"fileName\": \"string\",\n \"id\": \"9228dd9b-937a-a4b2-d0fb-cd2cc5f1da05\"\n },\n {\n \"contentType\": \"string\",\n \"createdAt\": \"2016-12-14T21:17:59.673Z\",\n \"fileName\": \"string\",\n \"id\": \"78081d0e-7894-e9a9-9bd5-32a5a059c5eb\"\n }\n ],\n \"id\": \"c9aae7c2-3c9d-7759-932b-efbee357c28e\",\n \"required\": true,\n \"status\": \"PENDING_REVIEW\",\n \"title\": \"string\",\n \"expiresAt\": \"2009-05-21T18:27:32.057Z\",\n \"declinedReason\": \"QUALITY\",\n \"declinedCustomerDisplayReason\": \"string\",\n \"validationStatus\": \"WARNING_EXPIRING_DOCUMENT\",\n \"validationMessage\": \"string\",\n \"lastUpdatedBy\": \"string\",\n \"lastUpdatedAt\": \"1984-04-12T00:57:33.447Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "310a3641-ddda-4c23-85ed-231c515b1083", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a77a1e5-577e-4495-adba-7105e377e97e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "880f3eaa-ce7a-4e52-9aeb-380b0fbaf2ff", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60639c49-5f1a-42c3-89e6-b92a219dcbc5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6156c740-5599-451f-86f2-a4513dcc658c", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c054ebb5-8cfc-4b7a-a285-804a1f92280b", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17ea455e-93e8-4bab-bec9-d737b538fa20", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb62dbdc-223f-4f12-9ce2-b063f7ccbd07", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe9d15e-6bf2-4f23-8c55-5828ac903a35", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "documents", ":documentId", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a0fb6b3c-07d0-1202-5cad-742c4104f797", "key": "documentId", "description": "(Required) ID of the document to acknowledge warnings for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64f7629e-08e9-43e8-a49a-239d6e9ebb04", "name": "Upload document", "request": { "name": "Upload document", "description": { "content": "Stores a document used for onboarding, RFIs, or other activities", "type": "text/plain" }, "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) " } ] } }, "response": [ { "id": "d6eec5bc-9efa-4c38-bcbd-63ce8dde5df7", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contentType\": \"string\",\n \"createdAt\": \"1985-12-10T16:12:29.371Z\",\n \"fileName\": \"string\",\n \"id\": \"e0ed9699-8a53-4618-6156-bcee4567d609\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "656167c8-4ad7-4614-a773-aa2448518e6b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f34b1144-ac73-4b50-91a3-54750461f1ac", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7276e9b-4442-464d-8dea-aaa0d965a1d8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717a5977-30e0-415f-8806-35b5ca8c4805", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe78c546-c766-45b1-83bd-5a7757c98f8a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66c09b92-94ee-4435-ac9b-0fb5e5717e1d", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bacccb61-6017-46d4-8b77-d4be804797d3", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e7d27c2-8b34-48ce-8ef5-7234ce3f7411", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecf8a395-600e-4fe6-9690-a9678d2e7e6c", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34d173e7-133c-4c14-93b5-129ff86095f8", "name": "Get document requirements", "request": { "name": "Get document requirements", "description": { "content": "Lists required documents for the account and their status", "type": "text/plain" }, "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "2735f3b9-c08c-4297-af96-a0a1158971f5", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"documentRequirements\": [\n {\n \"description\": \"string\",\n \"documentType\": \"TRADE_LICENSE\",\n \"required\": false,\n \"title\": \"string\"\n },\n {\n \"description\": \"string\",\n \"documentType\": \"BANK_STATEMENT\",\n \"required\": true,\n \"title\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16351fbc-ae7a-4fc0-ae23-3be134d23b3c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e9eb871-8260-48fd-bcd7-6bd31048d19f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d5f66a-b840-483a-890e-9a270cccbabb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22e569a0-d702-4f6d-8b86-21e9d6cdc8f4", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fa71189-5ba2-43e9-bee9-b88815cf0168", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d9f401f-0adb-471a-88aa-6a2d46ad4664", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02aac313-088f-4099-b0c6-3f33ff865e18", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "documents", "required" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ef18646a-8821-48f9-b45a-3f9774640f0e", "name": "Users", "description": { "content": "User management", "type": "text/plain" }, "item": [ { "id": "5c161ad0-28e7-4e5f-9f68-bddd91060dc5", "name": "Get user", "request": { "name": "Get user", "description": { "content": "Get a user linked to the account", "type": "text/plain" }, "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a04fb696-880d-41f9-bbe1-1987ac3d84f6", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9035c472-ebaf-aca9-1c20-a906c83472aa\",\n \"idpId\": \"500cb423-cf08-b23f-f35d-b7dd981b3cce\",\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"displayName\": \"string\",\n \"blockedStatus\": \"BLOCKED\",\n \"role\": \"PREPARER\",\n \"accountId\": \"ff01e3c5-534e-60ca-084b-958c42d365fd\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2c9787c-1839-44d0-b97d-afb5ee549669", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75956817-19d8-4dc0-bdf8-5a72631259a3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "622bd2b8-f3f5-41aa-a14c-f3b259b6fdac", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a40e195-348d-49c0-92c3-2b676a01bbe7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57afd8b7-ecd1-45f0-9bdf-889be40939a5", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5047296a-c37e-481c-8c5e-aff65b2df694", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d57a81-0718-4f6a-b616-8e055921f2ba", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "543f938f-abbb-4601-8673-508056297595", "name": "Update user", "request": { "name": "Update user", "description": { "content": "Update user display name and blocked status", "type": "text/plain" }, "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e7ddb392-d6a8-4e53-a8a4-fc7b6000fa91", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9035c472-ebaf-aca9-1c20-a906c83472aa\",\n \"idpId\": \"500cb423-cf08-b23f-f35d-b7dd981b3cce\",\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"displayName\": \"string\",\n \"blockedStatus\": \"BLOCKED\",\n \"role\": \"PREPARER\",\n \"accountId\": \"ff01e3c5-534e-60ca-084b-958c42d365fd\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddbc1611-81c4-464b-bb45-0bfda2384d90", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f52f919e-f685-45a7-b27d-112d47876327", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a9acba3-402f-496d-9f73-d0ffb060d9ab", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f1abd83-bb69-4b00-a89d-d4d0e053623a", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46ce063b-9032-4a7e-a5f0-da06d560fe64", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "896a68ed-2aa0-427d-a19a-535756bd70aa", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85080e39-b30d-48bc-8d5b-57c915eca38d", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12ce2bbd-29e4-4441-bdb7-dcea4581c549", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"string\",\n \"userBlockedStatus\": \"NOT_BLOCKED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fbfdf7a-b95e-4681-aa52-5fe828de0ad5", "name": "Delete user", "request": { "name": "Delete user", "description": { "content": "Deactivate a user linked to the account", "type": "text/plain" }, "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "a3e8b673-64af-4e34-8c8a-cf2b0f4607dc", "name": "No Content", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e067e1d6-ab51-46d6-8cb8-c257c0fdc448", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13801314-fa61-4350-97e8-b02dc249f14d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f51dc43-26c3-4a73-a189-56ea18f04fcc", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72da0f41-d88c-4426-b523-65ee627ccece", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "331af69f-f81c-4709-a11a-3ac01bbe2cb6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc159acc-5f0c-4e41-8e7f-008ce7fbeb39", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77866f86-dd61-4213-9c08-748f5fc3e8bd", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c65fee-a82b-4f90-be04-eed873bc0ac4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f50c603-c3b8-493d-8649-40785935c04d", "name": "Update user role", "request": { "name": "Update user role", "description": { "content": "Update the role of a user linked to the account", "type": "text/plain" }, "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7528863f-43e5-4169-a11c-a7df41de87bf", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9035c472-ebaf-aca9-1c20-a906c83472aa\",\n \"idpId\": \"500cb423-cf08-b23f-f35d-b7dd981b3cce\",\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"displayName\": \"string\",\n \"blockedStatus\": \"BLOCKED\",\n \"role\": \"PREPARER\",\n \"accountId\": \"ff01e3c5-534e-60ca-084b-958c42d365fd\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1da8c6f3-af1a-469c-ae75-9665e7fcf6fb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20c652d0-5eb5-4121-af07-04b895a23966", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "693630b4-162e-4a7a-8096-00db0e1ac9b5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7dd62e-6ec0-4f26-a11c-c8b1a2193533", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a3af180-1f0c-49fa-b542-0aba9a358acf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d06961e-cff6-4add-862b-40edafc0f13f", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea1736dc-6b38-40dd-8727-43ec4297f3d5", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff2fd11f-3ad3-43f1-9773-181f545a9658", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "users", ":id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "id", "description": "(Required) Unique identifier of the user" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"role\": \"VIEWER\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "527fe09e-702e-4bb7-b9ff-8d606b9700c5", "name": "Invite user", "request": { "name": "Invite user", "description": { "content": "Create an invite for a user to join the account. The invited user completes a self sign-up process and sets up their own credentials. The account must be in **APPLICATION_APPROVED** or **ACTIVE** status. See the [**Users integration guide**](/docs/guides/accounts/users) for more details.", "type": "text/plain" }, "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cea0e42d-031a-4509-8978-109fe6f59010", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"inviteId\": \"e7f8f665-361f-1c86-7415-5130a653ac87\",\n \"inviteUrl\": \"string\",\n \"expiresAt\": \"1997-01-13T17:04:19.919Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac3bee52-99ef-4fe0-991f-5f8ed30a7440", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f055a9d-8599-4ffa-9d62-d8c2f7a0b4f1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0772bd07-98b9-4b00-b8c6-3c5dc51622cb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e801aacd-a84d-4d0c-ae0e-3d3e959e656b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28319a26-4f3c-404a-b1e1-d281ce7113d6", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7efee2a1-d00a-4743-8457-1273dfc31022", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d34f41-b405-4dd6-9d52-9c63aa43bff6", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05411086-5051-4aba-a7a1-5cf8012935dc", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38a179f9-e033-43b1-9a76-135d62d553fb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"EXECUTOR\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "814863aa-ef19-48bf-b7e6-2b835d017bcf", "name": "Resend invite", "request": { "name": "Resend invite", "description": { "content": "Resending revokes the old token and creates a new invite URL", "type": "text/plain" }, "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "2313cc87-9211-42a6-9a0e-194e370554a4", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"inviteId\": \"e7f8f665-361f-1c86-7415-5130a653ac87\",\n \"inviteUrl\": \"string\",\n \"expiresAt\": \"1997-01-13T17:04:19.919Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4d099d3-9056-4ed4-b21a-896834923198", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff10a9c6-8597-478f-b22d-2e9fa18c879f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be39bdb9-a885-47d7-ab87-b981b3fc2cb4", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f05f3777-828d-4943-9f6f-2422a964045b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dfc6b83-d278-4bcc-bfb0-7ef70ee3108b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4f77b31-7ca1-47d9-aa0d-e26135a93826", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48b1d436-5088-4e1a-915f-3794578f26f0", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff635903-67c6-480b-b8d7-a9ae140b526f", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72da6871-8350-4be3-9fca-2fdb7ce95bc7", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c05862fa-76fe-4ead-9ad9-dbc270da4e4e", "name": "List users", "request": { "name": "List users", "description": { "content": "Get all active users linked to the account", "type": "text/plain" }, "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "07e1efae-5d23-4a63-9049-fdcd80d85768", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"a8d29a26-5311-25ee-3206-e8de61f178d1\",\n \"idpId\": \"ecdb4aff-08bf-72dc-f52e-0d73044a150b\",\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"displayName\": \"string\",\n \"blockedStatus\": \"NOT_BLOCKED\",\n \"role\": \"VIEWER\",\n \"accountId\": \"56db9060-3ccc-3380-a9ec-e82d44f16852\"\n },\n {\n \"id\": \"4ab94485-3666-7d5d-43ac-4ba9c48783c1\",\n \"idpId\": \"f60ab99c-98bf-e995-f892-1c6f3e303fcb\",\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"displayName\": \"string\",\n \"blockedStatus\": \"NOT_BLOCKED\",\n \"role\": \"PREPARER\",\n \"accountId\": \"f4e5cce1-ee39-581e-53d6-78569d19c3be\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b4d6260-ce92-4a45-af1e-33805cd4b581", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e596ab7-d492-411b-9656-2379fdcdac04", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d98c8253-9062-4542-949a-52ca0a946b5b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddec2a40-f19e-41a2-a774-71f65592e355", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f907cdf4-6daf-4f31-8a47-57a4d62e35d1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f199d89-f457-4dd7-a92d-57673521ef17", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501a3e9f-ce96-4a23-be89-2479b126c805", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13c40c46-2606-46c0-84b7-b91ae84c09d9", "name": "Get invite", "request": { "name": "Get invite", "description": { "content": "Get invite details including invite URL and status", "type": "text/plain" }, "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "5aabb8c7-9df2-4272-aafd-586516977c7f", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"inviteId\": \"d0a2c0e8-61a8-6921-3a87-9806244fbf86\",\n \"maskedEmail\": \"string\",\n \"fullName\": \"string\",\n \"role\": \"PREPARER\",\n \"inviteUrl\": \"string\",\n \"expiresAt\": \"1983-07-18T06:03:08.394Z\",\n \"status\": \"REVOKED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5771c4b2-45d9-4656-902d-187f56e87a30", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5da41773-6140-413f-9e81-7c673ba79cac", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eefdd3fa-53b2-40aa-acf2-697011257209", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8567f23-43d1-4f6d-8f03-8d70f5ef7810", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d038031-1466-4983-b867-3d8757744c08", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "725c2c49-cda3-4b5d-a011-891a56e4d6db", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa35bc6f-b13c-4934-8964-8cbda21ace61", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "account", "users", "invite", ":inviteId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e038b313-0b04-48d3-867e-7fee463501db", "key": "inviteId", "description": "(Required) Unique identifier of the invite" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ID of account for which operation is to be performed", "key": "AccountId", "value": "e038b313-0b04-48d3-867e-7fee463501db" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "69e2fd5c-584c-4006-af2b-09431dfe3372", "name": "Payment Requests", "description": { "content": "Payment request management", "type": "text/plain" }, "item": [ { "id": "10c4eb23-0c88-4a29-984f-ecb2729d8224", "name": "Set a payment-link preview logo (Sandbox)", "request": { "name": "Set a payment-link preview logo (Sandbox)", "description": { "content": "Uploads a logo override for one payment request without changing the account's branding.\nThe override is shown by embedded, hosted and shareable payment links for that request.\nThis endpoint is only available in sandbox/test environments.\n", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests", ":paymentRequestId", "preview-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "paymentRequestId", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "key": "logo", "type": "file", "description": "(Required) " } ] } }, "response": [ { "id": "a376f1ee-7091-4b92-988b-8a96a006b7ae", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":paymentRequestId", "preview-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "paymentRequestId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "logo", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentRequestId\": \"17221515-805a-1013-a384-ebdcfe414037\",\n \"logoUrl\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d63a2ec-6f49-4524-9b8f-00242df22261", "name": "Reset a payment-link preview logo (Sandbox)", "request": { "name": "Reset a payment-link preview logo (Sandbox)", "description": { "content": "Removes the logo override from one payment request so it uses the account branding logo again.\nThis endpoint is only available in sandbox/test environments.\n", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests", ":paymentRequestId", "preview-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "paymentRequestId", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" } ], "method": "DELETE" }, "response": [ { "id": "66fe7bf8-acd5-4b0a-bee0-c3d5db89691d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":paymentRequestId", "preview-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "paymentRequestId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09d2a2fa-d56a-4e7f-aa17-7807b54dd3ef", "name": "Refresh payment session", "request": { "name": "Refresh payment session", "description": { "content": "Refreshes the payment session token and returns the updated payment request. A refreshed payment session grants 1 hour to view and complete the payment. This endpoint is only applicable for payment requests with an execution mode of HOSTED_PAGE and a status of UNPAID or PART_PAID. If the request does not meet these criteria, a bad request will be returned.", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT" }, "response": [ { "id": "b0a2b2a9-1c05-461d-8e6e-611ae05d1cbc", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"529776b0-2fd9-ff3a-0a67-1924404f1cfa\",\n \"amount\": 150,\n \"currency\": \"AED\",\n \"documentReference\": \"string\",\n \"executionMode\": \"PAYMENT_LINK\",\n \"externalId\": \"string\",\n \"id\": \"26bdcc98-8afb-a39a-2cdb-aa81b336265b\",\n \"payerId\": \"697a6193-e63b-cc3c-a762-add5226a157e\",\n \"paymentMethods\": [\n \"BANK_TRANSFER\"\n ],\n \"status\": \"CANCELLED\",\n \"dueDate\": \"1981-10-08\",\n \"documentId\": \"1549e383-d91a-7680-22c8-983422d838da\",\n \"paymentLinkReference\": \"string\",\n \"paymentUrl\": \"string\",\n \"successRedirectUrl\": \"string\",\n \"cancelRedirectUrl\": \"string\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"542dae31-e3df-eb5b-0ec4-2663077b57eb\",\n \"payoutPurposeOfPayment\": \"FUND_INVESTMENT\",\n \"payoutReference\": \"string\"\n },\n \"amountPaid\": 50,\n \"amountRemaining\": 100,\n \"payments\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"reference\": \"REF123\",\n \"status\": \"PENDING\",\n \"sendCurrency\": \"USDT\",\n \"sendAmount\": 272.48,\n \"receiveCurrency\": \"AED\",\n \"receiveAmount\": 1000,\n \"method\": \"BANK_TRANSFER\",\n \"accountId\": \"123e4567-e89b-12d3-a456-426614174004\",\n \"payerId\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"paymentRequestId\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"createdAt\": \"2023-10-01T12:00:00Z\",\n \"details\": {\n \"value\": \"\"\n },\n \"payout\": {\n \"beneficiaryId\": {\n \"value\": \"\"\n },\n \"reference\": {\n \"value\": \"\"\n },\n \"transactionReference\": {\n \"value\": \"\"\n },\n \"purposeOfPayment\": {\n \"value\": \"\"\n },\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"reference\": \"REF123\",\n \"status\": \"PENDING\",\n \"sendCurrency\": \"USDT\",\n \"sendAmount\": 272.48,\n \"receiveCurrency\": \"AED\",\n \"receiveAmount\": 1000,\n \"method\": \"BANK_TRANSFER\",\n \"accountId\": \"123e4567-e89b-12d3-a456-426614174004\",\n \"payerId\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"paymentRequestId\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"createdAt\": \"2023-10-01T12:00:00Z\",\n \"details\": {\n \"value\": \"\"\n },\n \"payout\": {\n \"beneficiaryId\": {\n \"value\": \"\"\n },\n \"reference\": {\n \"value\": \"\"\n },\n \"transactionReference\": {\n \"value\": \"\"\n },\n \"purposeOfPayment\": {\n \"value\": \"\"\n },\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f37f4bcb-5f8c-43f9-93ff-810ea6dec22e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78cb7515-414c-48db-a3e2-3643b1c5c6a5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96574f9f-eae1-40be-8be3-cd64b8d0b624", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0a560d0-85b1-4a71-911e-e16706ffee37", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad737a05-b283-44f5-9101-2376b5008f14", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd28873c-1692-4ffd-866e-d6b2a979264e", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ee97a82-27f6-40e5-989a-eeabce6f7368", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64cbfefb-59fb-4cac-9487-251d9e76c336", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id", "refresh-session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "62ab01b0-7fd5-fb63-7271-628157b5ee08", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09bd9d57-620d-4bad-bb88-4bf31c7a211e", "name": "Simulate a payment (Sandbox)", "request": { "name": "Simulate a payment (Sandbox)", "description": { "content": "Simulates a successful bank transfer or crypto payment against an existing payment request.\nThis triggers the full payment lifecycle including status updates and webhook notifications,\nwithout requiring actual bank transfers or cryptocurrency transactions.\n\nThe payment request must be in UNPAID or PART_PAID status.\nIf no amount is specified, the full remaining balance is used.\n\nAfter a successful simulation:\n- The payment request status will be updated to PAID (or PART_PAID for partial amounts)\n- Webhook notifications will be sent to your registered endpoints\n- The payment will be visible when querying the payment request\n- The wallet balance will be updated\n\nThis endpoint is only available in sandbox/test environments.\n", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "simulate-payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentMethod\": \"BANK_TRANSFER\",\n \"paymentRequestReference\": \"REQ-123456\",\n \"amount\": 1000,\n \"cryptoCurrency\": \"USDT\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "818925c6-d633-4892-86f7-bbe0757ed2bb", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "simulate-payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentMethod\": \"BANK_TRANSFER\",\n \"paymentRequestReference\": \"REQ-123456\",\n \"amount\": 1000,\n \"cryptoCurrency\": \"USDT\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentRequestId\": \"961f4727-9353-d2cc-fc1a-44c3ef133625\",\n \"paymentId\": \"04f0c326-b876-dc21-7249-236482a02a6c\",\n \"paymentReference\": \"string\",\n \"paymentMethod\": \"BANK_TRANSFER\",\n \"amount\": 8461.460682604069,\n \"currency\": \"AED\",\n \"paymentRequestStatus\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35ea354c-e9b9-41ff-ae56-f22b791c9b1b", "name": "List payment requests", "request": { "name": "List payment requests", "description": { "content": "List all payment requests for an account", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "999616ad-9614-4715-ae5e-92817c3e52f0", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"accountId\": \"fa844d42-85de-4719-9ccf-34dcc134d2b2\",\n \"amount\": 150,\n \"currency\": \"AED\",\n \"documentReference\": \"string\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"stri\",\n \"id\": \"34bedcaf-ffdc-aacb-d48f-74aa77292d93\",\n \"payerId\": \"891d23ed-1eec-19b2-94fa-b5984a475413\",\n \"paymentMethods\": [\n \"CRYPTO\"\n ],\n \"status\": \"PART_PAID\",\n \"dueDate\": \"1978-07-11\",\n \"documentId\": \"906bb40c-a588-0b76-e102-3b664f666b2f\",\n \"paymentLinkReference\": \"string\",\n \"paymentUrl\": \"string\",\n \"successRedirectUrl\": \"string\",\n \"cancelRedirectUrl\": \"string\",\n \"autoSendPaymentLink\": true,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": {\n \"value\": \"\"\n },\n \"payoutPurposeOfPayment\": {\n \"value\": \"\"\n },\n \"payoutReference\": {\n \"value\": \"\"\n }\n },\n \"amountPaid\": 50,\n \"amountRemaining\": 100,\n \"payments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"accountId\": \"94ba1dcd-ae4f-6db7-3c2c-91934ff738dc\",\n \"amount\": 150,\n \"currency\": \"AED\",\n \"documentReference\": \"string\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"stri\",\n \"id\": \"1b0341dd-e5e0-4616-34ab-63ab61b83925\",\n \"payerId\": \"d6e94516-1d12-00c1-ded1-ddd899218e4b\",\n \"paymentMethods\": [\n \"CARD\"\n ],\n \"status\": \"PART_PAID\",\n \"dueDate\": \"2005-11-19\",\n \"documentId\": \"9e3fbe6d-c60c-8cb6-0bf2-2169b199968b\",\n \"paymentLinkReference\": \"string\",\n \"paymentUrl\": \"string\",\n \"successRedirectUrl\": \"string\",\n \"cancelRedirectUrl\": \"string\",\n \"autoSendPaymentLink\": true,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": {\n \"value\": \"\"\n },\n \"payoutPurposeOfPayment\": {\n \"value\": \"\"\n },\n \"payoutReference\": {\n \"value\": \"\"\n }\n },\n \"amountPaid\": 50,\n \"amountRemaining\": 100,\n \"payments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"page\": {\n \"size\": 7915,\n \"number\": 279,\n \"totalElements\": 9349,\n \"totalPages\": 5779\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30f59bd7-213e-4f78-ad26-3ee3fd9e71a9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f36ef471-329c-4aed-9415-ea163c5969e9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3e2743a-2325-4a09-8ac4-cb6ed45f9162", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a403b918-1f6f-4902-aa19-0a996cf99d88", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ac26d56-dedb-4d8b-9d33-a010ce53bd0a", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "044f7208-7156-44f1-a34f-92308f1469fc", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa06594a-5121-4a1e-ad13-54f4b949c012", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22fa2009-4e47-4642-8690-590e9f7b74ac", "name": "Create payment request", "request": { "name": "Create payment request", "description": {}, "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2d6a9b35-037b-44c7-baa2-c19753383838", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"529776b0-2fd9-ff3a-0a67-1924404f1cfa\",\n \"amount\": 150,\n \"currency\": \"AED\",\n \"documentReference\": \"string\",\n \"executionMode\": \"PAYMENT_LINK\",\n \"externalId\": \"string\",\n \"id\": \"26bdcc98-8afb-a39a-2cdb-aa81b336265b\",\n \"payerId\": \"697a6193-e63b-cc3c-a762-add5226a157e\",\n \"paymentMethods\": [\n \"BANK_TRANSFER\"\n ],\n \"status\": \"CANCELLED\",\n \"dueDate\": \"1981-10-08\",\n \"documentId\": \"1549e383-d91a-7680-22c8-983422d838da\",\n \"paymentLinkReference\": \"string\",\n \"paymentUrl\": \"string\",\n \"successRedirectUrl\": \"string\",\n \"cancelRedirectUrl\": \"string\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"542dae31-e3df-eb5b-0ec4-2663077b57eb\",\n \"payoutPurposeOfPayment\": \"FUND_INVESTMENT\",\n \"payoutReference\": \"string\"\n },\n \"amountPaid\": 50,\n \"amountRemaining\": 100,\n \"payments\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"reference\": \"REF123\",\n \"status\": \"PENDING\",\n \"sendCurrency\": \"USDT\",\n \"sendAmount\": 272.48,\n \"receiveCurrency\": \"AED\",\n \"receiveAmount\": 1000,\n \"method\": \"BANK_TRANSFER\",\n \"accountId\": \"123e4567-e89b-12d3-a456-426614174004\",\n \"payerId\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"paymentRequestId\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"createdAt\": \"2023-10-01T12:00:00Z\",\n \"details\": {\n \"value\": \"\"\n },\n \"payout\": {\n \"beneficiaryId\": {\n \"value\": \"\"\n },\n \"reference\": {\n \"value\": \"\"\n },\n \"transactionReference\": {\n \"value\": \"\"\n },\n \"purposeOfPayment\": {\n \"value\": \"\"\n },\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"reference\": \"REF123\",\n \"status\": \"PENDING\",\n \"sendCurrency\": \"USDT\",\n \"sendAmount\": 272.48,\n \"receiveCurrency\": \"AED\",\n \"receiveAmount\": 1000,\n \"method\": \"BANK_TRANSFER\",\n \"accountId\": \"123e4567-e89b-12d3-a456-426614174004\",\n \"payerId\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"paymentRequestId\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"createdAt\": \"2023-10-01T12:00:00Z\",\n \"details\": {\n \"value\": \"\"\n },\n \"payout\": {\n \"beneficiaryId\": {\n \"value\": \"\"\n },\n \"reference\": {\n \"value\": \"\"\n },\n \"transactionReference\": {\n \"value\": \"\"\n },\n \"purposeOfPayment\": {\n \"value\": \"\"\n },\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02394965-402b-4352-910b-6338b59e4639", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c93df348-1efa-4be1-b3a4-c654b69e503b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e673f0d-6b95-4b5d-881a-612b1d2e2318", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a890e4d-8f70-44c3-a2cf-4cc80d96f61b", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab02f9d0-5acd-4e50-af5a-15485c03e990", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68bfff08-f14f-406c-bc84-ee8d48325c4b", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d34d4b0-83ff-432a-9bfe-47f1e6ccebe2", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a08c355b-9c31-4e96-924a-51152fd0dfb3", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae586aee-79a0-46f1-a3b1-612b22e4db5e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 99.99,\n \"currency\": \"AED\",\n \"documentReference\": \"INV-2025-001\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"REQ-123456\",\n \"paymentMethods\": [\n \"CARD\",\n \"CRYPTO\"\n ],\n \"payerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"payer\": {\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n \"dueDate\": \"2025-06-30\",\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"successRedirectUrl\": \"https://example.com/success\",\n \"cancelRedirectUrl\": \"https://example.com/cancel\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"7123edab-491c-c3c9-2958-1066aeb2bb44\",\n \"payoutPurposeOfPayment\": \"SHARES_INVESTMENT\",\n \"payoutReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2305828f-0a19-4a9b-878c-c4464501d649", "name": "Upload document", "request": { "name": "Upload document", "description": { "content": "Hubpay requires an official document (such as an Invoice, Purchase Order, Sales Purchase Agreement, Commercial Contract etc.) to verify the transaction details and ensure compliance with UAE regulatory requirements.", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) " } ] } }, "response": [ { "id": "93b733dd-259c-4442-b663-f30a22f66bad", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contentType\": \"string\",\n \"createdAt\": \"1985-12-10T16:12:29.371Z\",\n \"fileName\": \"string\",\n \"id\": \"e0ed9699-8a53-4618-6156-bcee4567d609\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88ae4313-5e87-4198-9771-5223d80a1017", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8059a006-b966-4d92-9dcb-cf932d8f686e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "510cb091-dd59-430b-9520-df7a598552a2", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76c35f67-db97-47d8-bea2-2c797e48f488", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a48676ab-3936-4de7-9b81-308ac77fd929", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9a166f0-8493-4b3a-9876-9a525806ae97", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4df7af6-d41a-4eb5-84eb-ca31a4b6e239", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d9ef497-aee4-4894-b139-15bd5fae5152", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a248c3a4-f717-4db5-a5b7-fcc46a8a2ad4", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "documents", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06c100ef-01e4-46b9-916e-5822641d8422", "name": "Get a payment request by ID", "request": { "name": "Get a payment request by ID", "description": { "content": "Retrieve a single payment request by id", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "d504b661-6421-46f3-b142-411d4b888ba5", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"529776b0-2fd9-ff3a-0a67-1924404f1cfa\",\n \"amount\": 150,\n \"currency\": \"AED\",\n \"documentReference\": \"string\",\n \"executionMode\": \"PAYMENT_LINK\",\n \"externalId\": \"string\",\n \"id\": \"26bdcc98-8afb-a39a-2cdb-aa81b336265b\",\n \"payerId\": \"697a6193-e63b-cc3c-a762-add5226a157e\",\n \"paymentMethods\": [\n \"BANK_TRANSFER\"\n ],\n \"status\": \"CANCELLED\",\n \"dueDate\": \"1981-10-08\",\n \"documentId\": \"1549e383-d91a-7680-22c8-983422d838da\",\n \"paymentLinkReference\": \"string\",\n \"paymentUrl\": \"string\",\n \"successRedirectUrl\": \"string\",\n \"cancelRedirectUrl\": \"string\",\n \"autoSendPaymentLink\": false,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": \"542dae31-e3df-eb5b-0ec4-2663077b57eb\",\n \"payoutPurposeOfPayment\": \"FUND_INVESTMENT\",\n \"payoutReference\": \"string\"\n },\n \"amountPaid\": 50,\n \"amountRemaining\": 100,\n \"payments\": [\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"reference\": \"REF123\",\n \"status\": \"PENDING\",\n \"sendCurrency\": \"USDT\",\n \"sendAmount\": 272.48,\n \"receiveCurrency\": \"AED\",\n \"receiveAmount\": 1000,\n \"method\": \"BANK_TRANSFER\",\n \"accountId\": \"123e4567-e89b-12d3-a456-426614174004\",\n \"payerId\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"paymentRequestId\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"createdAt\": \"2023-10-01T12:00:00Z\",\n \"details\": {\n \"value\": \"\"\n },\n \"payout\": {\n \"beneficiaryId\": {\n \"value\": \"\"\n },\n \"reference\": {\n \"value\": \"\"\n },\n \"transactionReference\": {\n \"value\": \"\"\n },\n \"purposeOfPayment\": {\n \"value\": \"\"\n },\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"reference\": \"REF123\",\n \"status\": \"PENDING\",\n \"sendCurrency\": \"USDT\",\n \"sendAmount\": 272.48,\n \"receiveCurrency\": \"AED\",\n \"receiveAmount\": 1000,\n \"method\": \"BANK_TRANSFER\",\n \"accountId\": \"123e4567-e89b-12d3-a456-426614174004\",\n \"payerId\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"paymentRequestId\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"createdAt\": \"2023-10-01T12:00:00Z\",\n \"details\": {\n \"value\": \"\"\n },\n \"payout\": {\n \"beneficiaryId\": {\n \"value\": \"\"\n },\n \"reference\": {\n \"value\": \"\"\n },\n \"transactionReference\": {\n \"value\": \"\"\n },\n \"purposeOfPayment\": {\n \"value\": \"\"\n },\n \"amount\": {\n \"value\": \"\"\n },\n \"currency\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23864603-9040-420e-8934-c36f4f529c17", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ab0a08e-085b-4254-9892-3b9fde465dd9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ed4ae8e-c257-4887-9a88-7f59c42a2164", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8382e9d6-3912-428f-b74b-1bcdd4d6470f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1f8ac34-fa4d-473c-b29b-de7d8636c5c1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "925b3c79-9b1a-4bb5-8609-00af1bbc8d97", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5a388da-7bc7-47c6-8eae-ad62f42dedfc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payment request" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42fd0e8d-9131-4822-8236-4e6cfab5ae44", "name": "Get a specific payment", "request": { "name": "Get a specific payment", "description": { "content": "Get a specific payment under a payment request", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "ceb8a23c-2ebb-44e5-ad26-0bdcc3334c6d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"reference\": \"REF123\",\n \"status\": \"PENDING\",\n \"sendCurrency\": \"USDT\",\n \"sendAmount\": 272.48,\n \"receiveCurrency\": \"AED\",\n \"receiveAmount\": 1000,\n \"method\": \"BANK_TRANSFER\",\n \"accountId\": \"123e4567-e89b-12d3-a456-426614174004\",\n \"payerId\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"paymentRequestId\": \"123e4567-e89b-12d3-a456-426614174002\",\n \"createdAt\": \"2023-10-01T12:00:00Z\",\n \"details\": {\n \"issuer\": \"string\",\n \"issuerCountry\": \"string\",\n \"scheme\": \"VISA\",\n \"cardType\": \"CREDIT\",\n \"last4\": \"string\"\n },\n \"payout\": {\n \"beneficiaryId\": \"e92626a4-539e-646d-3e99-b2bea709ab3a\",\n \"reference\": \"string\",\n \"transactionReference\": \"string\",\n \"purposeOfPayment\": \"ADVISORY_FEES\",\n \"amount\": 4179.094196272182,\n \"currency\": \"string\",\n \"status\": \"INITIATED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d69c898c-a7b3-4fa5-ae8a-79537b111dd5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5661dd6b-756d-437b-8f56-7206c4c30369", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34205da5-1939-45ee-960c-b6905f237d8b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f8af3f5-6fa0-4b7c-b7ee-34b95c28082c", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "952446dc-331f-40c0-af6e-55c1d9cfe09b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59feb066-a9c1-4e5d-993f-4cc5cc2d27a8", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eff0ff48-6302-49ea-bce1-2be82737e510", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd439a66-3b13-481f-b836-b3770fb5a959", "name": "Find payment requests by external ID", "request": { "name": "Find payment requests by external ID", "description": { "content": "Find payment requests for an account by external ID", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "externalId", "value": "EXT-001", "description": "(Required) External ID to search for" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "aea4485f-7208-4a85-a3dc-262f1fc15ef8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"accountId\": \"fa844d42-85de-4719-9ccf-34dcc134d2b2\",\n \"amount\": 150,\n \"currency\": \"AED\",\n \"documentReference\": \"string\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"stri\",\n \"id\": \"34bedcaf-ffdc-aacb-d48f-74aa77292d93\",\n \"payerId\": \"891d23ed-1eec-19b2-94fa-b5984a475413\",\n \"paymentMethods\": [\n \"CRYPTO\"\n ],\n \"status\": \"PART_PAID\",\n \"dueDate\": \"1978-07-11\",\n \"documentId\": \"906bb40c-a588-0b76-e102-3b664f666b2f\",\n \"paymentLinkReference\": \"string\",\n \"paymentUrl\": \"string\",\n \"successRedirectUrl\": \"string\",\n \"cancelRedirectUrl\": \"string\",\n \"autoSendPaymentLink\": true,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": {\n \"value\": \"\"\n },\n \"payoutPurposeOfPayment\": {\n \"value\": \"\"\n },\n \"payoutReference\": {\n \"value\": \"\"\n }\n },\n \"amountPaid\": 50,\n \"amountRemaining\": 100,\n \"payments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"accountId\": \"94ba1dcd-ae4f-6db7-3c2c-91934ff738dc\",\n \"amount\": 150,\n \"currency\": \"AED\",\n \"documentReference\": \"string\",\n \"executionMode\": \"HOSTED_PAGE\",\n \"externalId\": \"stri\",\n \"id\": \"1b0341dd-e5e0-4616-34ab-63ab61b83925\",\n \"payerId\": \"d6e94516-1d12-00c1-ded1-ddd899218e4b\",\n \"paymentMethods\": [\n \"CARD\"\n ],\n \"status\": \"PART_PAID\",\n \"dueDate\": \"2005-11-19\",\n \"documentId\": \"9e3fbe6d-c60c-8cb6-0bf2-2169b199968b\",\n \"paymentLinkReference\": \"string\",\n \"paymentUrl\": \"string\",\n \"successRedirectUrl\": \"string\",\n \"cancelRedirectUrl\": \"string\",\n \"autoSendPaymentLink\": true,\n \"payoutDetails\": {\n \"payoutBeneficiaryId\": {\n \"value\": \"\"\n },\n \"payoutPurposeOfPayment\": {\n \"value\": \"\"\n },\n \"payoutReference\": {\n \"value\": \"\"\n }\n },\n \"amountPaid\": 50,\n \"amountRemaining\": 100,\n \"payments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"page\": {\n \"size\": 7915,\n \"number\": 279,\n \"totalElements\": 9349,\n \"totalPages\": 5779\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "663734f7-b884-4880-9538-dd9a84ad18a6", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "749369d4-3cbe-4d76-ab90-a759a636438a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "417ad68e-6532-464b-b1b1-011e11766b5f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b520d34-ee5b-4ece-b82e-1b01d67fa98f", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1508e3f-61c8-4e3f-8a00-c3fa07663319", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae16d823-7475-4aca-8ce3-a2b5ab308389", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cc3fd94-2687-43f8-921a-00dcb3ba04bc", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a61fd490-d0f6-4def-8af2-43e1f2d311a3", "name": "Payers", "description": { "content": "Payer management", "type": "text/plain" }, "item": [ { "id": "5eb32dc2-7433-49dd-8460-ca3c4fad9260", "name": "Get a payer by ID", "request": { "name": "Get a payer by ID", "description": {}, "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "be9a262b-ca44-4a4a-bea9-f2399e2263b8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"6fa9898c-db98-c258-b68c-5e58ac992e64\",\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"fullLegalName\": \"string\",\n \"id\": \"894a9915-aa06-913f-f86c-de6a93c80541\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bff3a2a-a5b0-49f8-a307-e3c3db897078", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd1b671b-cde4-4468-ae6f-d4ae671ee9b0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a58fad73-f32a-4ccb-a5fc-2df81a119311", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09b77f23-0289-4b68-8cb1-571ab8cfa9e7", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a92d8946-939f-4295-bcdc-7acd950922be", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae3c5882-008e-48e1-bc91-e5671f13673a", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cc094dc-c7d5-434b-9bbf-8884f2bef31a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59fecf0c-9372-4e6f-ad61-dfc2927dcb49", "name": "Update payer", "request": { "name": "Update payer", "description": { "content": "Overwrites the existing payer with the provided details", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "34128bd9-2404-4413-99a3-770ca98251ae", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"6fa9898c-db98-c258-b68c-5e58ac992e64\",\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"fullLegalName\": \"string\",\n \"id\": \"894a9915-aa06-913f-f86c-de6a93c80541\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96eac3ab-8798-4409-b779-a43196fcd699", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e39408f-0123-4e0e-a0b1-a36d8c1fe7fb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05bac35a-192b-4cf0-b661-cd8206f58d16", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "100c8ba2-b8b3-4b8d-87ea-bbcefe0cb748", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eed15070-de1e-47f8-b8d4-b9568d510428", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c5eaedc-6d69-4126-b820-815185b25cca", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47010698-85f4-4f28-82f9-d99ab4601ab8", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8dc62e4-caa6-41db-9c5a-29c0d6b70423", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "id", "description": "(Required) Unique identifier of the payer" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6397f5c-22de-46c2-8eac-31f6c1a233da", "name": "List payers", "request": { "name": "List payers", "description": { "content": "List all payers for an account", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "3c367bab-c35a-4c78-8044-e4b7f1affb2d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"accountId\": \"ae099b71-e314-6b90-f2ca-055ce16f88c8\",\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"fullLegalName\": \"string\",\n \"id\": \"d842ddc5-0559-2d02-1f4f-4e42ea83d907\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n {\n \"accountId\": \"301e67ac-d255-32a7-4a91-582dbe8d3cbc\",\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"fullLegalName\": \"string\",\n \"id\": \"f7f3bcbe-0b43-a560-4dd1-3b8f6e6a2b77\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n }\n ],\n \"page\": {\n \"size\": 8040,\n \"number\": 6209,\n \"totalElements\": 7897,\n \"totalPages\": 1095\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b238e37f-8319-4403-ab4d-8311f2631cb7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca756b90-9d8e-4664-98d4-358b1584d0dc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f0c259f-d99a-468f-99e1-8f34aaa7bc51", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c1f2f5b-8403-419a-9957-aea94ffcdbd9", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0fb4f3c-e3e4-40c8-9198-0e17c515ddaf", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10c7d028-98f7-4c09-a6f6-6909fcc9b3e2", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45307001-8952-4308-b76f-0f208d59d0f9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9eeb524a-3e17-40d1-bed5-22dc8931e990", "name": "Create payer", "request": { "name": "Create payer", "description": {}, "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "007a96cf-fc07-4a07-a1eb-674a71599419", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountId\": \"6fa9898c-db98-c258-b68c-5e58ac992e64\",\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"fullLegalName\": \"string\",\n \"id\": \"894a9915-aa06-913f-f86c-de6a93c80541\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12aad8fd-224f-4d40-a1c3-15edda1d18bc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6d0cb22-c03c-497e-87c9-b078ff2bddf8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64190f8b-a275-4cea-ba64-eb574740dba8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f06e7dd0-23e2-42c6-84f7-e52556401afa", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dda3f887-a90f-4eee-9494-2500ad141c8b", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70d0560-e951-433d-94be-266f125a84a0", "name": "Conflict", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c60c27-0024-4d20-9438-d9497692f2de", "name": "Unsupported Media Type", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08461a0b-1f00-4663-9e5c-5900eb8e4d76", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11082ff2-e879-43c6-9ad7-1c3e01c9dfdf", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"EX123\",\n \"fullLegalName\": \"string\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60a33e08-0eda-4584-9879-ab6ee9c9573e", "name": "Find payers by external ID", "request": { "name": "Find payers by external ID", "description": { "content": "Find payers for an account by external ID", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index (0..N)" }, { "disabled": false, "key": "size", "value": "20", "description": "The size of the page to be returned" }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "sort", "value": "string", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported." }, { "disabled": false, "key": "externalId", "value": "EXT-001", "description": "(Required) External ID to search for" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e0343219-25c1-4100-be14-e8fe031fec63", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"accountId\": \"ae099b71-e314-6b90-f2ca-055ce16f88c8\",\n \"country\": \"string\",\n \"cryptoEnabled\": false,\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"fullLegalName\": \"string\",\n \"id\": \"d842ddc5-0559-2d02-1f4f-4e42ea83d907\",\n \"type\": \"INDIVIDUAL\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": false,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n },\n {\n \"accountId\": \"301e67ac-d255-32a7-4a91-582dbe8d3cbc\",\n \"country\": \"string\",\n \"cryptoEnabled\": true,\n \"emailAddress\": \"string\",\n \"externalId\": \"string\",\n \"fullLegalName\": \"string\",\n \"id\": \"f7f3bcbe-0b43-a560-4dd1-3b8f6e6a2b77\",\n \"type\": \"BUSINESS\",\n \"phoneNumber\": \"string\",\n \"notificationEnabled\": true,\n \"address\": \"string\",\n \"areaOrCity\": \"string\",\n \"provinceOrState\": \"string\",\n \"postalCode\": \"string\"\n }\n ],\n \"page\": {\n \"size\": 8040,\n \"number\": 6209,\n \"totalElements\": 7897,\n \"totalPages\": 1095\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6349d089-cb4d-4231-9a0a-a9cd9c2baa8e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8214fbe-a21c-476a-a685-0f698e8fc7d6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49c15545-2096-4d67-8a5c-175595e3c3ac", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4da71d06-872c-486b-bc0d-241cd9286dd5", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d81f51eb-e892-43bd-9ed1-555ecb590612", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "480f76ac-3f9d-4425-b678-898b0dd52dba", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15d6409b-eaed-406b-965a-9eab371c441b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payers", "find" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" }, { "key": "sort", "value": "string" }, { "key": "sort", "value": "string" }, { "key": "externalId", "value": "EXT-001" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f25f968e-fc24-4d02-941e-b7bca0568130", "name": "Receipts", "description": { "content": "Payment receipt management", "type": "text/plain" }, "item": [ { "id": "b8d9e554-a38b-40f4-ab1d-f074859bedea", "name": "List payment receipts", "request": { "name": "List payment receipts", "description": { "content": "Retrieve all receipts uploaded by payers for a specific payment. Currently supports bank transfer proof-of-payment documents (e.g., bank transfer screenshots, payment confirmations) that payers optionally upload when completing a payment via the payment link or hosted payment page. Only available for payments where the payer chose to include a receipt.", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a754e9fd-6ae4-4c0e-88a7-8cb62c4b88ff", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentId\": \"b0ae5614-2494-49fa-b075-8050b5eb84ba\",\n \"receipts\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440001\",\n \"fileName\": \"bank-transfer-screenshot.pdf\",\n \"contentType\": \"application/pdf\",\n \"fileSize\": 245760,\n \"uploadedAt\": \"2025-11-06T10:30:00Z\",\n \"downloadUrl\": \"https://api.hubpay.io/v1/collections/payment-requests/payments/b0ae5614-2494-49fa-b075-8050b5eb84ba/receipts/550e8400-e29b-41d4-a716-446655440001/download\"\n },\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440001\",\n \"fileName\": \"bank-transfer-screenshot.pdf\",\n \"contentType\": \"application/pdf\",\n \"fileSize\": 245760,\n \"uploadedAt\": \"2025-11-06T10:30:00Z\",\n \"downloadUrl\": \"https://api.hubpay.io/v1/collections/payment-requests/payments/b0ae5614-2494-49fa-b075-8050b5eb84ba/receipts/550e8400-e29b-41d4-a716-446655440001/download\"\n }\n ],\n \"totalCount\": 2\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5bf3cf8-869b-47bb-b2de-95120cdec21a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8da52c49-a501-470c-8274-2ec6f9d02ebc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec00e47b-772b-4f5d-8f0d-a340905aae59", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09ac4ae6-71a7-4c4e-ba46-786c073c82ec", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45748e6d-4cbb-4f9b-b68f-d584a70fba05", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6cab8a4-90aa-46f0-8efc-fe42d5526d40", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94c99a97-82d4-4abe-880e-7e1b916b7afb", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa610b02-997f-4b07-8095-52b096f7485c", "name": "Download payment receipt", "request": { "name": "Download payment receipt", "description": { "content": "Download a specific receipt file uploaded by a payer. Currently supports bank transfer proof-of-payment documents (e.g., bank transfer screenshots, payment confirmations) that payers optionally upload when completing a payment via the payment link or hosted payment page.", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a4b2e781-f318-456d-98c9-254657943085", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5daa93c1-5104-467d-a7b7-22dbbf06720b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eb5bf2f-93a8-4917-9e7a-f9a15bf80716", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a556fc29-efdd-4645-a3cb-3dfa5bf9a869", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8fb7271-fc0c-418b-8c8e-ecd86111f7f8", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "957ca0e9-89bd-40e4-bcf6-6ebea420c7b1", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46f66b78-afc3-4788-91f1-e6cdecd0f71e", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c15d65af-b516-47e4-9f8c-708b85cc25b5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "payment-requests", "payments", ":paymentId", "receipts", ":receiptId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b0ae5614-2494-49fa-b075-8050b5eb84ba", "key": "paymentId", "description": "(Required) Unique identifier of the payment" }, { "disabled": false, "type": "any", "value": "550e8400-e29b-41d4-a716-446655440001", "key": "receiptId", "description": "(Required) Unique identifier of the receipt" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "35d1d987-c834-4503-9927-de6903d1268b", "name": "Rates", "description": { "content": "Exchange rates for collections", "type": "text/plain" }, "item": [ { "id": "26879399-9390-453d-b16f-58999da9d5c6", "name": "Get Exchange rates", "request": { "name": "Get Exchange rates", "description": { "content": "Use the Get Exchange rates endpoint to retrieve indicative exchange rates for a specific collection type", "type": "text/plain" }, "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sourceType", "value": "CRYPTO", "description": "(Required) Source type: FIAT or CRYPTO" }, { "disabled": false, "key": "sourceCurrency", "value": "AED", "description": "(Required) Currency the payer will send (fiat or crypto)" }, { "disabled": false, "key": "sourceCountry", "value": "GB", "description": "(Required) Country of the payer" }, { "disabled": false, "key": "destinationType", "value": "CRYPTO", "description": "(Required) Payment type: FIAT or CRYPTO" }, { "disabled": false, "key": "destinationCurrency", "value": "AED", "description": "(Required) Currency of the collection. This is the amount credited to the destination account" }, { "disabled": false, "key": "destinationAmount", "value": "1000", "description": "(Required) Collection amount to be received in the destination currency" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Hubpay account context. Set the accountId collection variable.", "key": "AccountId", "value": "{{accountId}}" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "6523e36f-1b33-41b1-a950-31be256429aa", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceType", "value": "CRYPTO" }, { "key": "sourceCurrency", "value": "AED" }, { "key": "sourceCountry", "value": "GB" }, { "key": "destinationType", "value": "CRYPTO" }, { "key": "destinationCurrency", "value": "AED" }, { "key": "destinationAmount", "value": "1000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"destinationAmount\": 1000,\n \"destinationCurrency\": \"AED\",\n \"destinationType\": \"CRYPTO\",\n \"sourceAmount\": 1000,\n \"sourceCountry\": \"GB\",\n \"sourceCurrency\": \"AED\",\n \"sourceType\": \"CRYPTO\",\n \"exchangeRate\": 1.59234\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3da968f8-e4af-474e-9da5-d424644cac01", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceType", "value": "CRYPTO" }, { "key": "sourceCurrency", "value": "AED" }, { "key": "sourceCountry", "value": "GB" }, { "key": "destinationType", "value": "CRYPTO" }, { "key": "destinationCurrency", "value": "AED" }, { "key": "destinationAmount", "value": "1000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df30cddc-b050-4e35-94ca-3e1cfa2b5122", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceType", "value": "CRYPTO" }, { "key": "sourceCurrency", "value": "AED" }, { "key": "sourceCountry", "value": "GB" }, { "key": "destinationType", "value": "CRYPTO" }, { "key": "destinationCurrency", "value": "AED" }, { "key": "destinationAmount", "value": "1000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59865634-570f-45ab-8234-a48840c69ff5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceType", "value": "CRYPTO" }, { "key": "sourceCurrency", "value": "AED" }, { "key": "sourceCountry", "value": "GB" }, { "key": "destinationType", "value": "CRYPTO" }, { "key": "destinationCurrency", "value": "AED" }, { "key": "destinationAmount", "value": "1000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc04e08c-3c7c-4dd8-9a9f-86baf07725c0", "name": "Not Found", "originalRequest": { "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceType", "value": "CRYPTO" }, { "key": "sourceCurrency", "value": "AED" }, { "key": "sourceCountry", "value": "GB" }, { "key": "destinationType", "value": "CRYPTO" }, { "key": "destinationCurrency", "value": "AED" }, { "key": "destinationAmount", "value": "1000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dd9b17c-dfd8-4c32-bbc6-e338f8036cfa", "name": "Method Not Allowed", "originalRequest": { "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceType", "value": "CRYPTO" }, { "key": "sourceCurrency", "value": "AED" }, { "key": "sourceCountry", "value": "GB" }, { "key": "destinationType", "value": "CRYPTO" }, { "key": "destinationCurrency", "value": "AED" }, { "key": "destinationAmount", "value": "1000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48c2163a-8f14-4e99-9afd-c788b87d40a2", "name": "Too Many Requests", "originalRequest": { "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceType", "value": "CRYPTO" }, { "key": "sourceCurrency", "value": "AED" }, { "key": "sourceCountry", "value": "GB" }, { "key": "destinationType", "value": "CRYPTO" }, { "key": "destinationCurrency", "value": "AED" }, { "key": "destinationAmount", "value": "1000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13c38c00-0f8e-46d0-8dc6-44d137d137e3", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "v1", "collections", "rates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceType", "value": "CRYPTO" }, { "key": "sourceCurrency", "value": "AED" }, { "key": "sourceCountry", "value": "GB" }, { "key": "destinationType", "value": "CRYPTO" }, { "key": "destinationCurrency", "value": "AED" }, { "key": "destinationAmount", "value": "1000" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) ", "key": "AccountId", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"validation_failed\",\n \"message\": \"One or more fields are missing or invalid\",\n \"status\": 400,\n \"timestamp\": \"2025-06-10T10:15:31Z\",\n \"path\": \"/v1/collections/rates\",\n \"errors\": [\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n },\n {\n \"field\": \"sourceCurrency\",\n \"message\": \"Source currency is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://sandbox-api.hubpay.io", "type": "string", "description": "Hubpay API server. Defaults to sandbox." }, { "key": "clientId", "value": "", "type": "string", "description": "Sandbox client ID supplied by Hubpay." }, { "key": "clientSecret", "value": "", "type": "string", "description": "Sandbox client secret supplied by Hubpay. Do not commit a populated collection." }, { "key": "accountId", "value": "", "type": "string", "description": "Hubpay account ID used by operations that require AccountId." }, { "key": "accessToken", "value": "", "type": "string", "description": "Populated automatically by the authentication request test script." } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "info": { "_postman_id": "cf561f50-7f01-49f3-9eec-1a5d9e6d8c0b", "name": "Hubpay Connect API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Customer-ready collection generated from Hubpay's published OpenAPI specification.\n\n1. Set the clientId, clientSecret and accountId collection variables.\n2. Run Authentication > Generate JWT access token.\n3. The test script stores the returned token in accessToken for all other requests.\n\nThe default baseUrl is the Hubpay sandbox. Use separate production credentials and change baseUrl only when you are ready to go live." } }