{ "item": [ { "name": "Auth", "description": { "content": "OAuth 2.0 client credentials authentication.", "type": "text/plain" }, "item": [ { "name": "Get new access token", "request": { "name": "Get new access token", "description": {}, "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "noauth" }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PNSL" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PNSL" } ] }, "auth": { "type": "noauth" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token_type\": \"string\",\n \"expires_in\": 3320,\n \"access_token\": \"string\",\n \"scope\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PNSL" } ] }, "auth": { "type": "noauth" } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PNSL" } ] }, "auth": { "type": "noauth" } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PNSL" } ] }, "auth": { "type": "noauth" } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "pm.collectionVariables.set(\"accessToken\", \"\");" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.collectionVariables.set(\"accessToken\", \"\");", "if (pm.response.code >= 200 && pm.response.code < 300) {", " const body = pm.response.json();", " pm.test(\"Access token returned\", function () {", " pm.expect(body.access_token).to.be.a(\"string\").and.not.empty;", " });", " if (typeof body.access_token === \"string\" && body.access_token.trim()) {", " pm.collectionVariables.set(\"accessToken\", body.access_token);", " }", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Onboarding", "description": { "content": "Client onboarding applications and review status. Document intake is handled through Axiym's compliance KYB flow.", "type": "text/plain" }, "item": [ { "name": "Start Client Onboarding", "request": { "name": "Start Client Onboarding", "description": { "content": "Creates and immediately submits a client onboarding case for compliance review. Document intake is owned by Axiym's compliance KYB flow. The client is visible in `GET /clients` after approval; track the case with `GET /onboardings/{clientId}`.", "type": "text/plain" }, "url": { "path": [ "onboardings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"legalEntityName\": \"Test Corp Ltd\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"registrationDate\": \"2020-02-01\",\n \"incorporationDate\": \"2020-01-15\",\n \"currency\": \"USD\",\n \"partnerClientId\": \"my-internal-ref-001\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Onboarding application accepted and submitted for review.", "originalRequest": { "url": { "path": [ "onboardings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"legalEntityName\": \"Test Corp Ltd\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"registrationDate\": \"2020-02-01\",\n \"incorporationDate\": \"2020-01-15\",\n \"currency\": \"USD\",\n \"partnerClientId\": \"my-internal-ref-001\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"code\": \"AXI000221\",\n \"legalEntityName\": \"Acme Corporation\",\n \"status\": \"ONBOARDING\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"incorporationDate\": \"2020-01-15\",\n \"registrationDate\": \"2020-02-01\",\n \"currency\": \"USD\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"partnerClientId\": \"my-internal-ref-001\",\n \"paymentRails\": \"ZENUS_BANK\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "onboardings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"legalEntityName\": \"Test Corp Ltd\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"registrationDate\": \"2020-02-01\",\n \"incorporationDate\": \"2020-01-15\",\n \"currency\": \"USD\",\n \"partnerClientId\": \"my-internal-ref-001\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "onboardings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"legalEntityName\": \"Test Corp Ltd\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"registrationDate\": \"2020-02-01\",\n \"incorporationDate\": \"2020-01-15\",\n \"currency\": \"USD\",\n \"partnerClientId\": \"my-internal-ref-001\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "onboardings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"legalEntityName\": \"Test Corp Ltd\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"registrationDate\": \"2020-02-01\",\n \"incorporationDate\": \"2020-01-15\",\n \"currency\": \"USD\",\n \"partnerClientId\": \"my-internal-ref-001\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "onboardings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"legalEntityName\": \"Test Corp Ltd\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"registrationDate\": \"2020-02-01\",\n \"incorporationDate\": \"2020-01-15\",\n \"currency\": \"USD\",\n \"partnerClientId\": \"my-internal-ref-001\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "onboardings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"legalEntityName\": \"Test Corp Ltd\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"registrationDate\": \"2020-02-01\",\n \"incorporationDate\": \"2020-01-15\",\n \"currency\": \"USD\",\n \"partnerClientId\": \"my-internal-ref-001\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get Onboarding Status", "request": { "name": "Get Onboarding Status", "description": {}, "url": { "path": [ "onboardings", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "name": "Current state of the onboarding application.", "originalRequest": { "url": { "path": [ "onboardings", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"code\": \"AXI000221\",\n \"legalEntityName\": \"Acme Corporation\",\n \"status\": \"ONBOARDING\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"incorporationDate\": \"2020-01-15\",\n \"registrationDate\": \"2020-02-01\",\n \"currency\": \"USD\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"partnerClientId\": \"my-internal-ref-001\",\n \"paymentRails\": \"ZENUS_BANK\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "onboardings", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "onboardings", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "onboardings", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "onboardings", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Clients", "description": { "content": "Approved clients and their profile information.", "type": "text/plain" }, "item": [ { "name": "List all Clients", "request": { "name": "List all Clients", "description": {}, "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "first", "value": "10", "description": "Maximum number of items to return (page size)." }, { "disabled": true, "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==", "description": "Cursor for the next page, from the previous response's pageInfo.endCursor." }, { "disabled": true, "key": "searchQuery", "value": "Acme", "description": "Free-text search query." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "searchQuery", "value": "Acme" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"legalEntityName\": \"Acme Corporation\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"status\": \"ONBOARDING\",\n \"incorporationDate\": \"2020-01-15\",\n \"registrationDate\": \"2020-02-01\",\n \"paymentRails\": \"ZENUS_BANK\",\n \"currency\": \"USD\",\n \"code\": \"AXI000221\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"partnerClientId\": \"my-internal-ref-001\"\n },\n {\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"legalEntityName\": \"Acme Corporation\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"status\": \"ONBOARDING\",\n \"incorporationDate\": \"2020-01-15\",\n \"registrationDate\": \"2020-02-01\",\n \"paymentRails\": \"ZENUS_BANK\",\n \"currency\": \"USD\",\n \"code\": \"AXI000221\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"partnerClientId\": \"my-internal-ref-001\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "searchQuery", "value": "Acme" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "searchQuery", "value": "Acme" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "searchQuery", "value": "Acme" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "searchQuery", "value": "Acme" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "searchQuery", "value": "Acme" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get Client Profile", "request": { "name": "Get Client Profile", "description": {}, "url": { "path": [ "clients", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "clients", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"legalEntityName\": \"Acme Corporation\",\n \"legalAddress\": {\n \"postalCode\": \"10115\",\n \"country\": \"US\",\n \"address\": \"350 Fifth Avenue\",\n \"city\": \"New York\",\n \"addressExtended\": \"Suite 1200\",\n \"district\": \"NY\"\n },\n \"status\": \"ONBOARDING\",\n \"incorporationDate\": \"2020-01-15\",\n \"registrationDate\": \"2020-02-01\",\n \"paymentRails\": \"ZENUS_BANK\",\n \"currency\": \"USD\",\n \"code\": \"AXI000221\",\n \"disbursementAccount\": {\n \"accountNumber\": \"0123456789\"\n },\n \"partnerClientId\": \"my-internal-ref-001\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "clients", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "clients", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Credit Accounts", "description": { "content": "Credit limits and outstanding balances of your clients.", "type": "text/plain" }, "item": [ { "name": "List Credit Accounts", "request": { "name": "List Credit Accounts", "description": {}, "url": { "path": [ "clients", ":clientId", "credit-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "first", "value": "20", "description": "Maximum number of items to return (page size)." }, { "disabled": true, "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==", "description": "Cursor for the next page, from the previous response's pageInfo.endCursor." }, { "disabled": true, "key": "currency", "value": "USD", "description": "Filter by currency." }, { "disabled": true, "key": "paymentRails", "value": "ZENUS_BANK", "description": "Filter by payment rail." } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "clients", ":clientId", "credit-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"creditAccountId\": \"9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n \"paymentRails\": \"ZENUS_BANK\",\n \"currency\": \"USD\",\n \"creditLimit\": \"1000.00\",\n \"availableBalance\": \"1000.00\",\n \"principalOutstanding\": \"1000.00\",\n \"totalRepaymentAmount\": \"1000.00\",\n \"totalInterestAmount\": \"1000.00\",\n \"status\": \"PENDING\",\n \"balance\": \"1000.00\"\n },\n {\n \"creditAccountId\": \"9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n \"paymentRails\": \"ZENUS_BANK\",\n \"currency\": \"USD\",\n \"creditLimit\": \"1000.00\",\n \"availableBalance\": \"1000.00\",\n \"principalOutstanding\": \"1000.00\",\n \"totalRepaymentAmount\": \"1000.00\",\n \"totalInterestAmount\": \"1000.00\",\n \"status\": \"PENDING\",\n \"balance\": \"1000.00\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "credit-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "credit-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "clients", ":clientId", "credit-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "credit-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "clients", ":clientId", "credit-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "credit-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Receivables", "description": { "content": "Client payment funding, repayments, and receivable status.", "type": "text/plain" }, "item": [ { "name": "List Receivables", "request": { "name": "List Receivables", "description": {}, "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "first", "value": "20", "description": "Maximum number of items to return (page size)." }, { "disabled": true, "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==", "description": "Cursor for the next page, from the previous response's pageInfo.endCursor." }, { "disabled": true, "key": "currency", "value": "USD", "description": "Filter by currency." }, { "disabled": true, "key": "paymentRails", "value": "ZENUS_BANK", "description": "Filter by payment rail." }, { "disabled": true, "key": "status", "value": "PENDING", "description": "Filter by receivable status." } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" }, { "key": "status", "value": "PENDING" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"receivableId\": \"e5a9c3d1-7b2f-4a8e-9c1d-3f6b8a0e2c4d\",\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"issueDate\": \"2026-06-23T14:05:09Z\",\n \"initialPrincipal\": \"1000.00\",\n \"status\": \"PENDING\",\n \"currency\": \"USD\",\n \"currentPrincipal\": \"1000.00\",\n \"repaymentAmount\": \"1000.00\",\n \"paymentTransaction\": {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n \"paymentRails\": \"ZENUS_BANK\",\n \"disbursedTransaction\": {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n \"repaymentTransactions\": [\n {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n }\n ]\n },\n {\n \"receivableId\": \"e5a9c3d1-7b2f-4a8e-9c1d-3f6b8a0e2c4d\",\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"issueDate\": \"2026-06-23T14:05:09Z\",\n \"initialPrincipal\": \"1000.00\",\n \"status\": \"PENDING\",\n \"currency\": \"USD\",\n \"currentPrincipal\": \"1000.00\",\n \"repaymentAmount\": \"1000.00\",\n \"paymentTransaction\": {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n \"paymentRails\": \"ZENUS_BANK\",\n \"disbursedTransaction\": {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n \"repaymentTransactions\": [\n {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n }\n ]\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" }, { "key": "status", "value": "PENDING" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" }, { "key": "status", "value": "PENDING" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" }, { "key": "status", "value": "PENDING" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" }, { "key": "status", "value": "PENDING" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" }, { "key": "status", "value": "PENDING" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "paymentRails", "value": "ZENUS_BANK" }, { "key": "status", "value": "PENDING" } ], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Fund a Payment", "request": { "name": "Fund a Payment", "description": {}, "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentTransaction\": {\n \"paymentId\": \"TX-001\",\n \"timestamp\": \"2026-05-11T10:00:00Z\",\n \"data\": {}\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentTransaction\": {\n \"paymentId\": \"TX-001\",\n \"timestamp\": \"2026-05-11T10:00:00Z\",\n \"data\": {}\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"receivableId\": \"e5a9c3d1-7b2f-4a8e-9c1d-3f6b8a0e2c4d\",\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"issueDate\": \"2026-06-23T14:05:09Z\",\n \"initialPrincipal\": \"1000.00\",\n \"status\": \"PENDING\",\n \"currency\": \"USD\",\n \"currentPrincipal\": \"1000.00\",\n \"repaymentAmount\": \"1000.00\",\n \"paymentTransaction\": {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n \"paymentRails\": \"ZENUS_BANK\",\n \"disbursedTransaction\": {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n \"repaymentTransactions\": [\n {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentTransaction\": {\n \"paymentId\": \"TX-001\",\n \"timestamp\": \"2026-05-11T10:00:00Z\",\n \"data\": {}\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentTransaction\": {\n \"paymentId\": \"TX-001\",\n \"timestamp\": \"2026-05-11T10:00:00Z\",\n \"data\": {}\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentTransaction\": {\n \"paymentId\": \"TX-001\",\n \"timestamp\": \"2026-05-11T10:00:00Z\",\n \"data\": {}\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentTransaction\": {\n \"paymentId\": \"TX-001\",\n \"timestamp\": \"2026-05-11T10:00:00Z\",\n \"data\": {}\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentTransaction\": {\n \"paymentId\": \"TX-001\",\n \"timestamp\": \"2026-05-11T10:00:00Z\",\n \"data\": {}\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentTransaction\": {\n \"paymentId\": \"TX-001\",\n \"timestamp\": \"2026-05-11T10:00:00Z\",\n \"data\": {}\n },\n \"paymentRails\": \"ZENUS_BANK\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Repay a client from your balance", "request": { "name": "Repay a client from your balance", "description": { "content": "Applies funds from your own settlement balance to the client's outstanding receivables. Use it when incoming funds could not be attributed to a client automatically and were credited to your settlement account as unallocated. The funds must already be on your settlement account for `currency` and `paymentRails` (see `GET /accounts` in the Account API); an `amount` above that balance is rejected. Allocation is FIFO across the client's active receivables; the request does not select a particular receivable. Any amount beyond the client's `totalRepaymentAmount` remains on the client's settlement balance. The response acknowledges the request; read the receivable and credit account after settlement.", "type": "text/plain" }, "url": { "path": [ "clients", ":clientId", "repayments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Repayment accepted from your settlement balance.", "originalRequest": { "url": { "path": [ "clients", ":clientId", "repayments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"OK\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "repayments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "repayments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "clients", ":clientId", "repayments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "repayments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "clients", ":clientId", "repayments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "repayments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Transfer client balance to your account", "request": { "name": "Transfer client balance to your account", "description": { "content": "Moves funds from the client's settlement balance to your own settlement account for the same currency and payment rail. Use it to return an overpayment or funds received in error: once on your account, withdraw them with the Account API. This is an instant book transfer; no bank movement occurs. Funds already applied to a receivable are not returned by this operation.", "type": "text/plain" }, "url": { "path": [ "clients", ":clientId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Transfer accepted; the client balance is moved to your settlement account.", "originalRequest": { "url": { "path": [ "clients", ":clientId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"OK\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "clients", ":clientId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "clients", ":clientId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"1000.00\",\n \"currency\": \"USD\",\n \"paymentRails\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a Receivable", "request": { "name": "Get a Receivable", "description": {}, "url": { "path": [ "clients", ":clientId", "receivables", ":receivableId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." }, { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "receivableId", "description": "(Required) Receivable identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables", ":receivableId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." }, { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "receivableId", "description": "(Required) Receivable identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"receivableId\": \"e5a9c3d1-7b2f-4a8e-9c1d-3f6b8a0e2c4d\",\n \"clientId\": \"b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b\",\n \"issueDate\": \"2026-06-23T14:05:09Z\",\n \"initialPrincipal\": \"1000.00\",\n \"status\": \"PENDING\",\n \"currency\": \"USD\",\n \"currentPrincipal\": \"1000.00\",\n \"repaymentAmount\": \"1000.00\",\n \"paymentTransaction\": {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n \"paymentRails\": \"ZENUS_BANK\",\n \"disbursedTransaction\": {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n \"repaymentTransactions\": [\n {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n },\n {\n \"txId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"txTimestamp\": \"2026-06-23T14:05:09Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables", ":receivableId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." }, { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "receivableId", "description": "(Required) Receivable identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables", ":receivableId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." }, { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "receivableId", "description": "(Required) Receivable identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables", ":receivableId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." }, { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "receivableId", "description": "(Required) Receivable identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables", ":receivableId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." }, { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "receivableId", "description": "(Required) Receivable identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables", ":receivableId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." }, { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "receivableId", "description": "(Required) Receivable identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "clients", ":clientId", "receivables", ":receivableId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b7e8c1a2-9f43-4d2e-8a6b-1c2d3e4f5a6b", "key": "clientId", "description": "(Required) Client identifier (UUID)." }, { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "receivableId", "description": "(Required) Receivable identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Settings", "description": { "content": "Reference data used when constructing API requests.", "type": "text/plain" }, "item": [ { "name": "Payment Rails", "request": { "name": "Payment Rails", "description": {}, "url": { "path": [ "settings", "payment-rails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "settings", "payment-rails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"code\": \"ZENUS_BANK\",\n \"description\": \"Zenus Bank — USD/EUR wire settlement\",\n \"currencies\": [\n \"USD\",\n \"USD\"\n ]\n },\n {\n \"code\": \"ZENUS_BANK\",\n \"description\": \"Zenus Bank — USD/EUR wire settlement\",\n \"currencies\": [\n \"USD\",\n \"USD\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "settings", "payment-rails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "settings", "payment-rails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "settings", "payment-rails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "settings", "payment-rails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "settings", "payment-rails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "settings", "payment-rails" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Webhook Subscriptions", "description": { "content": "Webhook endpoint registration, testing, and signing-key retrieval.", "type": "text/plain" }, "item": [ { "name": "List all Subscriptions", "request": { "name": "List all Subscriptions", "description": {}, "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "first", "value": "20", "description": "Maximum number of items to return (page size)." }, { "disabled": true, "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==", "description": "Cursor for the next page, from the previous response's pageInfo.endCursor." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"subscriptionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"endpoint\": \"https://api.acme.example/webhooks\"\n },\n {\n \"subscriptionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"endpoint\": \"https://api.acme.example/webhooks\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create Subscription", "request": { "name": "Create Subscription", "description": {}, "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"endpoint\": \"https://api.acme.example/webhooks\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Test Subscription", "request": { "name": "Test Subscription", "description": {}, "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"OK\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": true, "description": "Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Disable Subscription", "request": { "name": "Disable Subscription", "description": {}, "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"endpoint\": \"https://api.acme.example/webhooks\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get Webhook Public Key", "request": { "name": "Get Webhook Public Key", "description": {}, "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"publicKeyId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"algorithm\": \"ED25519\",\n \"publicKey\": \"string\",\n \"createdAt\": \"2026-06-23T14:05:09Z\",\n \"active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, `Onboarding Cannot Be Finished` when finishing an already rejected case, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the `X-Request-Id` response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://partner-api.sandbox.axiym.io/api/v1", "key": "baseUrl" }, { "key": "clientId", "value": "", "type": "string" }, { "key": "clientSecret", "value": "", "type": "string" }, { "key": "accessToken", "value": "", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] }, "info": { "name": "Axiym PNSL API v2.0.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "PNSL stands for Pay Now, Settle Later. The PNSL API lets a Payment Network request financing for an eligible payment from one of its onboarded clients. Axiym creates the resulting receivable and disburses the financed amount to the Payment Network's configured funding destination; the Payment Network carries out the underlying client payment in its own system. Repayment is attributed automatically from incoming funds, or applied from the Payment Network's own settlement balance. PNSL is a financing and repayment API, not a payment-processing API.\n\nGenerated from /openapi/pnsl-api/2.0.0.json. API version: 2.0.0 (current).\n\nImport this collection and set its clientId and clientSecret variables locally. The baseUrl defaults to Sandbox. Send the Auth folder's token request; a successful response saves accessToken for subsequent requests. Avoid environment variables with these same names, since they override collection variables. Request another token when it expires or when changing environments or credentials.\n\nRequests are grouped by API resource, not execution order. Send individual requests following the integration guide. Replace example identifiers and payloads with your sandbox data. For a new logical operation use a new idempotency key; keep the same key when retrying that operation." } }