{ "item": [ { "name": "Auth", "description": { "content": "OAuth 2.0 client credentials authentication.", "type": "text/plain" }, "item": [ { "name": "Get access token", "request": { "name": "Get access token", "description": { "content": "Exchange your OAuth client credentials for an Account API access token.\n\nSend the returned token as `Authorization: Bearer ` on subsequent requests. Request the `ACCOUNT` scope.", "type": "text/plain" }, "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "ACCOUNT" } ] } }, "response": [ { "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "ACCOUNT" } ] }, "auth": { "type": "noauth" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token_type\": \"string\",\n \"expires_in\": 3736,\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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "ACCOUNT" } ] }, "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "ACCOUNT" } ] }, "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "ACCOUNT" } ] }, "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": "Accounts", "description": { "content": "Axiym accounts, balances, and posted ledger activity.", "type": "text/plain" }, "item": [ { "name": "List accounts", "request": { "name": "List accounts", "description": { "content": "Returns the Axiym accounts available to your organization. Each account holds a balance in one currency.\n\nUse the optional filters to narrow the result by currency or account status.", "type": "text/plain" }, "url": { "path": [ "accounts" ], "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": "currency", "value": "USD", "description": "Filter by currency." }, { "disabled": true, "key": "status", "value": "ACTIVE", "description": "Filter by status." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Accounts.", "originalRequest": { "url": { "path": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\",\n \"balance\": \"48250.00\",\n \"status\": \"ACTIVE\"\n },\n {\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\",\n \"balance\": \"12500.00\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "10" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 account", "request": { "name": "Get account", "description": { "content": "Returns the current balance, currency, payment rail, and status of one Axiym account.", "type": "text/plain" }, "url": { "path": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Account.", "originalRequest": { "url": { "path": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\",\n \"balance\": \"48250.00\",\n \"status\": \"ACTIVE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 account statement", "request": { "name": "Get account statement", "description": { "content": "Returns posted credits and debits for one account, including opening and closing balances, movement totals, and entries in posting order.\n\n**Reconciliation**\n\n`openingBalance + totalCredited - totalDebited = closingBalance`\n\nEach entry also carries its running balance. Without `from` and `to`, the statement covers the account's full history.", "type": "text/plain" }, "url": { "path": [ "accounts", ":accountId", "statement" ], "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": "from", "value": "2026-06-01", "description": "First calendar day of the period (UTC), inclusive. The period bounds apply to the posting time of the movement." }, { "disabled": true, "key": "to", "value": "2026-06-30", "description": "Last calendar day of the period (UTC), inclusive. Adjacent statements chain without gaps: June `to=2026-06-30` is followed by July `from=2026-07-01`." }, { "disabled": true, "key": "type", "value": "DEBIT", "description": "Filter by credit or debit direction." } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Account statement for the period.", "originalRequest": { "url": { "path": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"openingBalance\": \"47750.00\",\n \"closingBalance\": \"48250.00\",\n \"totalCredited\": \"1005.00\",\n \"totalDebited\": \"505.00\",\n \"nodes\": [\n {\n \"entryId\": \"7f9a2d1c-8b31-4f59-9e2f-1d63c4a27b12\",\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"type\": \"DEBIT\",\n \"amount\": \"500.00\",\n \"currency\": \"USD\",\n \"balanceAfter\": \"12000.00\",\n \"occurredAt\": \"2026-07-14T20:07:31Z\",\n \"balanceBefore\": \"12500.00\",\n \"relatedResourceType\": \"WITHDRAWAL\",\n \"relatedResourceId\": \"9b4e2a1c-6d3f-4a8e-bc7d-1f2a3b4c5d6e\"\n },\n {\n \"entryId\": \"7f9a2d1c-8b31-4f59-9e2f-1d63c4a27b12\",\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"type\": \"DEBIT\",\n \"amount\": \"500.00\",\n \"currency\": \"USD\",\n \"balanceAfter\": \"12000.00\",\n \"occurredAt\": \"2026-07-14T20:07:31Z\",\n \"balanceBefore\": \"12500.00\",\n \"relatedResourceType\": \"WITHDRAWAL\",\n \"relatedResourceId\": \"9b4e2a1c-6d3f-4a8e-bc7d-1f2a3b4c5d6e\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Address Book", "description": { "content": "Registered external bank accounts and wallet addresses you own — the permitted deposit sources and withdrawal destinations.", "type": "text/plain" }, "item": [ { "name": "List address book entries", "request": { "name": "List address book entries", "description": { "content": "Returns registered external bank accounts and wallet addresses available as withdrawal destinations.\n\nOnly an `ACTIVE` entry can receive a withdrawal. Use the optional filters to narrow the result by currency or status.", "type": "text/plain" }, "url": { "path": [ "address-book" ], "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": "status", "value": "ACTIVE", "description": "Filter by status." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Page of your address book entries.", "originalRequest": { "url": { "path": [ "address-book" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"destinationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"ACTIVE\",\n \"currency\": \"USD\",\n \"accountNumber\": \"0123456789\",\n \"bank\": {\n \"bankName\": \"Bank of America\",\n \"address\": {\n \"city\": \"New York\",\n \"country\": \"US\"\n },\n \"swiftBic\": \"BOFAUS3NXXX\"\n },\n \"createdAt\": \"2026-06-12T14:05:00Z\"\n },\n {\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"status\": \"ACTIVE\",\n \"currency\": \"USDT\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\",\n \"createdAt\": \"2026-06-12T14:05:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "address-book" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "address-book" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "address-book" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "address-book" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "address-book" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "address-book" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 an address book entry", "request": { "name": "Get an address book entry", "description": { "content": "Returns one registered external bank account or wallet address, including its payment details and current status.\n\nUse its `destinationId` when creating a withdrawal after the entry is `ACTIVE`.", "type": "text/plain" }, "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Address book entry identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Address book entry.", "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Address book entry identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"destinationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"ACTIVE\",\n \"currency\": \"USD\",\n \"accountNumber\": \"0123456789\",\n \"bank\": {\n \"bankName\": \"Bank of America\",\n \"address\": {\n \"city\": \"New York\",\n \"country\": \"US\"\n },\n \"swiftBic\": \"BOFAUS3NXXX\"\n },\n \"createdAt\": \"2026-06-12T14:05:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Address book entry identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Address book entry identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Address book entry identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Address book entry identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Address book entry identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Address book entry identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Deposits", "description": { "content": "Incoming funds credited to your Axiym accounts.", "type": "text/plain" }, "item": [ { "name": "Get deposit instructions", "request": { "name": "Get deposit instructions", "description": { "content": "Returns the receiving details needed to deposit funds into one of your Axiym accounts.\n\n**Before sending funds**\n\nSend funds only from an `ACTIVE` entry in your address book. Third-party accounts cannot be used.\n\n**Instruction type**\n\n- Bank instructions contain the receiving-bank details and, when present, an account-specific `reference`. Include the reference on the transfer.\n- Wallet instructions contain the wallet address and blockchain network to use.", "type": "text/plain" }, "url": { "path": [ "accounts", ":accountId", "deposit-instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Deposit instructions for the account.", "originalRequest": { "url": { "path": [ "accounts", ":accountId", "deposit-instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"beneficiaryName\": \"Axi Labs AG\",\n \"accountNumber\": \"1050004921\",\n \"swiftBic\": \"ZEITPRSJXXX\",\n \"bankName\": \"Zenus Bank International Inc.\",\n \"reference\": \"RF11 0004 4901 01\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "accounts", ":accountId", "deposit-instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId", "deposit-instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId", "deposit-instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId", "deposit-instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "accounts", ":accountId", "deposit-instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "accounts", ":accountId", "deposit-instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "List deposits", "request": { "name": "List deposits", "description": { "content": "Returns incoming payments detected for your Axiym accounts. Deposits are accepted only from `ACTIVE` entries in your address book.\n\nUse the optional filters to narrow the results by account or deposit status.", "type": "text/plain" }, "url": { "path": [ "deposits" ], "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": "accountId", "value": "8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a", "description": "Filter by account." }, { "disabled": true, "key": "status", "value": "COMPLETED", "description": "Filter by status." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Page of deposits.", "originalRequest": { "url": { "path": [ "deposits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a" }, { "key": "status", "value": "COMPLETED" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"depositId\": \"4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c\",\n \"account\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"amount\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"status\": \"COMPLETED\",\n \"createdAt\": \"2026-06-14T18:02:11Z\",\n \"fee\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"remitterName\": \"Globex Corporation\",\n \"code\": \"AXI00000417\",\n \"transactionHash\": \"1a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f809\",\n \"reasonCode\": \"string\"\n },\n {\n \"depositId\": \"4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c\",\n \"account\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"amount\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"status\": \"COMPLETED\",\n \"createdAt\": \"2026-06-14T18:02:11Z\",\n \"fee\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"remitterName\": \"Globex Corporation\",\n \"code\": \"AXI00000417\",\n \"transactionHash\": \"1a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f809\",\n \"reasonCode\": \"string\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "deposits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a" }, { "key": "status", "value": "COMPLETED" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "deposits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a" }, { "key": "status", "value": "COMPLETED" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "deposits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a" }, { "key": "status", "value": "COMPLETED" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "deposits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a" }, { "key": "status", "value": "COMPLETED" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "deposits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a" }, { "key": "status", "value": "COMPLETED" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 deposit", "request": { "name": "Get deposit", "description": { "content": "Returns one incoming payment, including its current status, credited account, amount, currency, and available bank or blockchain details.", "type": "text/plain" }, "url": { "path": [ "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c", "key": "depositId", "description": "(Required) Deposit identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Deposit.", "originalRequest": { "url": { "path": [ "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c", "key": "depositId", "description": "(Required) Deposit identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"depositId\": \"4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c\",\n \"account\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"amount\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"status\": \"COMPLETED\",\n \"createdAt\": \"2026-06-14T18:02:11Z\",\n \"fee\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"remitterName\": \"Globex Corporation\",\n \"code\": \"AXI00000417\",\n \"transactionHash\": \"1a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f809\",\n \"reasonCode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c", "key": "depositId", "description": "(Required) Deposit identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c", "key": "depositId", "description": "(Required) Deposit identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c", "key": "depositId", "description": "(Required) Deposit identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c", "key": "depositId", "description": "(Required) Deposit identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c", "key": "depositId", "description": "(Required) Deposit identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "deposits", ":depositId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4c8e2b6a-1d9f-4e3b-a7c5-2f0a8d6b4e1c", "key": "depositId", "description": "(Required) Deposit identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Withdrawals", "description": { "content": "Outgoing payments from Axiym accounts to registered address book entries.", "type": "text/plain" }, "item": [ { "name": "List withdrawals", "request": { "name": "List withdrawals", "description": { "content": "Returns withdrawals created from your Axiym accounts, including their current execution status.\n\nUse the optional filters to narrow the result by source account, status, or `externalReference`.", "type": "text/plain" }, "url": { "path": [ "withdrawals" ], "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": "accountId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Filter by account." }, { "disabled": true, "key": "status", "value": "PENDING", "description": "Filter by status." }, { "disabled": true, "key": "externalReference", "value": "wd-2026-0714-01", "description": "Filter by your external reference." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Page of withdrawals.", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "wd-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"withdrawalId\": \"9b4e2a1c-6d3f-4a8e-bc7d-1f2a3b4c5d6e\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"sourceAmount\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"destination\": {\n \"currency\": \"USD\",\n \"accountNumber\": \"0123456789\",\n \"bank\": {\n \"bankName\": \"Bank of America\",\n \"address\": {\n \"country\": \"US\",\n \"streetName\": \"string\",\n \"buildingNumber\": \"string\",\n \"city\": \"New York\",\n \"region\": \"string\",\n \"postalCode\": \"string\"\n },\n \"swiftBic\": \"BOFAUS3NXXX\",\n \"clearingCode\": \"026009593\",\n \"clearingSystemCode\": \"USABA\"\n },\n \"destinationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"status\": \"PENDING\",\n \"createdAt\": \"2026-07-14T20:06:50Z\",\n \"code\": \"AXI00000418\",\n \"reference\": \"Treasury sweep\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"4e4b686d-9e4a-921d-e068-41bfb614914b\",\n \"name\": \"string\",\n \"contentType\": \"application/pdf\",\n \"size\": 280\n },\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"5838b19c-fcb2-381f-6d96-aa720e754071\",\n \"name\": \"string\",\n \"contentType\": \"application/pdf\",\n \"size\": 248\n }\n ],\n \"externalReference\": \"wd-2026-0714-01\",\n \"transactionHash\": \"9f8e7d6c5b4a39281706f5e4d3c2b1a0998877665544332211ffeeddccbbaa00\",\n \"reasonCode\": \"string\"\n },\n {\n \"withdrawalId\": \"9b4e2a1c-6d3f-4a8e-bc7d-1f2a3b4c5d6e\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"sourceAmount\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"1000.00\",\n \"currency\": \"USD\"\n },\n \"destination\": {\n \"currency\": \"USD\",\n \"accountNumber\": \"0123456789\",\n \"bank\": {\n \"bankName\": \"Bank of America\",\n \"address\": {\n \"country\": \"US\",\n \"streetName\": \"string\",\n \"buildingNumber\": \"string\",\n \"city\": \"New York\",\n \"region\": \"string\",\n \"postalCode\": \"string\"\n },\n \"swiftBic\": \"BOFAUS3NXXX\",\n \"clearingCode\": \"026009593\",\n \"clearingSystemCode\": \"USABA\"\n },\n \"destinationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"status\": \"PENDING\",\n \"createdAt\": \"2026-07-14T20:06:50Z\",\n \"code\": \"AXI00000418\",\n \"reference\": \"Treasury sweep\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"980a5d57-5872-5b3e-ce59-880241641166\",\n \"name\": \"string\",\n \"contentType\": \"application/pdf\",\n \"size\": 4128\n },\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"d4860916-f685-2216-805f-bb1b53e710e6\",\n \"name\": \"string\",\n \"contentType\": \"application/pdf\",\n \"size\": 6578\n }\n ],\n \"externalReference\": \"wd-2026-0714-01\",\n \"transactionHash\": \"9f8e7d6c5b4a39281706f5e4d3c2b1a0998877665544332211ffeeddccbbaa00\",\n \"reasonCode\": \"string\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "wd-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "wd-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "wd-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "wd-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "wd-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "accountId", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "wd-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 withdrawal", "request": { "name": "Create withdrawal", "description": { "content": "Creates an outgoing withdrawal from `sourceAccountId` to the address book entry selected by `destinationId`.\n\n**Requirements**\n\n- The source account and destination must be `ACTIVE`.\n- They must use the same currency.\n- `destinationId` must identify a registered address book entry.\n\nThe response contains the resolved source and destination details and has status `PENDING_CONFIRMATION`. Creation does not begin execution; confirm the returned `withdrawalId` with `POST /withdrawals/{withdrawalId}/confirm`.", "type": "text/plain" }, "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Withdrawal created and awaiting confirmation.", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"withdrawalId\": \"9b4e2a1c-6d3f-4a8e-bc7d-1f2a3b4c5d6e\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"sourceAccount\": {\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"fee\": {\n \"amount\": \"0.00\",\n \"currency\": \"USDT\"\n },\n \"destination\": {\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"currency\": \"USDT\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\n },\n \"code\": \"AXI00000418\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\",\n \"createdAt\": \"2026-07-14T20:06:50Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\"\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": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\"\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": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\"\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": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\"\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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\"\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": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\"\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 withdrawal", "request": { "name": "Get withdrawal", "description": { "content": "Returns the current state of one withdrawal, including its source account, destination, amounts, fee, and any completed wallet transaction hash.\n\nUse this as the authoritative status after creation or confirmation and when processing withdrawal webhooks.", "type": "text/plain" }, "url": { "path": [ "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Withdrawal.", "originalRequest": { "url": { "path": [ "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 \"withdrawalId\": \"9b4e2a1c-6d3f-4a8e-bc7d-1f2a3b4c5d6e\",\n \"status\": \"COMPLETED\",\n \"sourceAccount\": {\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"sourceAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"destinationAmount\": {\n \"amount\": \"500.00\",\n \"currency\": \"USDT\"\n },\n \"fee\": {\n \"amount\": \"0.00\",\n \"currency\": \"USDT\"\n },\n \"destination\": {\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"currency\": \"USDT\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\n },\n \"code\": \"AXI00000418\",\n \"transactionHash\": \"9f8e7d6c5b4a39281706f5e4d3c2b1a0998877665544332211ffeeddccbbaa00\",\n \"reference\": \"Treasury sweep\",\n \"externalReference\": \"wd-2026-0714-01\",\n \"createdAt\": \"2026-07-14T20:06:50Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": [ "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Confirm withdrawal", "request": { "name": "Confirm withdrawal", "description": { "content": "Confirms a withdrawal in `PENDING_CONFIRMATION` status and begins execution.\n\nThe request has no body. Use the `withdrawalId` returned by `POST /withdrawals` and provide a new `Idempotency-Key` for this confirmation request.", "type": "text/plain" }, "url": { "path": [ "withdrawals", ":withdrawalId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Withdrawal confirmed and queued for execution.", "originalRequest": { "url": { "path": [ "withdrawals", ":withdrawalId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"withdrawalId\": \"1e7c5a3b-8d2f-4b6e-9a0c-3d5f7b9e1c2a\",\n \"status\": \"PENDING\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"sourceAmount\": {\n \"amount\": \"12500.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"12500.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"0.00\",\n \"currency\": \"USD\"\n },\n \"destination\": {\n \"destinationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"currency\": \"USD\",\n \"accountNumber\": \"0123456789\",\n \"bank\": {\n \"bankName\": \"Bank of America\",\n \"address\": {\n \"city\": \"New York\",\n \"country\": \"US\"\n },\n \"swiftBic\": \"BOFAUS3NXXX\"\n }\n },\n \"code\": \"AXI00000419\",\n \"reference\": \"Invoice INV-20416\",\n \"externalReference\": \"wd-2026-0714-02\",\n \"createdAt\": \"2026-07-14T20:06:50Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "withdrawals", ":withdrawalId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": [ "withdrawals", ":withdrawalId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": [ "withdrawals", ":withdrawalId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": [ "withdrawals", ":withdrawalId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "withdrawals", ":withdrawalId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": [ "withdrawals", ":withdrawalId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "withdrawalId", "description": "(Required) Withdrawal identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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 } } ], "event": [] }, { "name": "Webhook Subscriptions", "description": { "content": "Webhook subscription management and webhook public keys.", "type": "text/plain" }, "item": [ { "name": "List webhook subscriptions", "request": { "name": "List webhook subscriptions", "description": { "content": "Returns the webhook subscriptions registered by your organization.", "type": "text/plain" }, "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, 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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 webhook subscription", "request": { "name": "Create webhook subscription", "description": { "content": "Registers an HTTPS endpoint to receive account, address book, and withdrawal notifications.\n\nYour endpoint must be publicly reachable and return a `2XX` response to the webhook `POST` request.", "type": "text/plain" }, "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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 webhook subscription", "request": { "name": "Test webhook subscription", "description": { "content": "Sends a test notification to one registered webhook endpoint.", "type": "text/plain" }, "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Unique client-generated key for safely retrying a funds-moving request. A UUID is recommended, but any unique string is accepted.\n\nRepeating the same request with the same key returns the original result instead of creating a duplicate withdrawal or confirmation.", "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 webhook subscription", "request": { "name": "Disable webhook subscription", "description": { "content": "Disables one webhook subscription so it no longer receives notifications.", "type": "text/plain" }, "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6e12d7c5-6367-b5c8-9438-989d4f11126f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "6e12d7c5-6367-b5c8-9438-989d4f11126f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "6e12d7c5-6367-b5c8-9438-989d4f11126f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "6e12d7c5-6367-b5c8-9438-989d4f11126f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "6e12d7c5-6367-b5c8-9438-989d4f11126f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "6e12d7c5-6367-b5c8-9438-989d4f11126f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6e12d7c5-6367-b5c8-9438-989d4f11126f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "6e12d7c5-6367-b5c8-9438-989d4f11126f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": { "content": "Returns a public key used to verify webhook signatures.", "type": "text/plain" }, "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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-07-14T20:08:00Z\",\n \"active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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, or the generic `Unprocessable Request`).", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "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 Account API v0.3.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Use the Account API to view Axiym accounts, registered address book entries, and account activity; retrieve deposit instructions and track deposits; create and confirm withdrawals; and receive webhook notifications. The access token identifies the organization that owns every account, address book entry, deposit, withdrawal, and webhook subscription.\n\n## Deposit flow\n\n1. Retrieve the receiving details with `GET /accounts/{accountId}/deposit-instructions`.\n2. Send the funds from an `ACTIVE` address book entry using those details.\n3. Track the incoming payment with `GET /deposits` and `GET /deposits/{depositId}` or deposit webhooks.\n\n## Withdrawal flow\n\n1. Select an `ACTIVE` source account and an `ACTIVE` address book entry in the same currency.\n2. Create the withdrawal with `POST /withdrawals`. The response returns its `withdrawalId` in `PENDING_CONFIRMATION` status.\n3. Confirm that identifier with `POST /withdrawals/{withdrawalId}/confirm` to begin execution.\n4. Track the outcome with `GET /withdrawals/{withdrawalId}` or withdrawal webhooks.\n\nGenerated from /openapi/account-api/0.3.0.yaml. API version: 0.3.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." } }