{ "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": "Creates an OAuth 2.0 access token using your client credentials. Request the `ACCOUNT` scope and send the returned token as a bearer token on subsequent Account API requests.", "type": "text/plain" }, "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "noauth" }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}", "description": "OAuth client identifier issued to your organization." }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}", "description": "Secret associated with your OAuth client credentials." }, { "disabled": false, "key": "grant_type", "value": "client_credentials", "description": "OAuth grant type. Send `client_credentials`." }, { "disabled": false, "key": "scope", "value": "ACCOUNT", "description": "Requested access scope. Send `ACCOUNT` for the Account API." } ] } }, "response": [ { "name": "Access token created.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "OAuth client identifier issued to your organization.", "type": "text/plain" }, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "description": { "content": "Secret associated with your OAuth client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "description": { "content": "OAuth grant type. Send `client_credentials`.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "Requested access scope. Send `ACCOUNT` for the Account API.", "type": "text/plain" }, "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\": 4234,\n \"access_token\": \"string\",\n \"scope\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "OAuth client identifier issued to your organization.", "type": "text/plain" }, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "description": { "content": "Secret associated with your OAuth client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "description": { "content": "OAuth grant type. Send `client_credentials`.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "Requested access scope. Send `ACCOUNT` for the Account API.", "type": "text/plain" }, "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" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "OAuth client identifier issued to your organization.", "type": "text/plain" }, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "description": { "content": "Secret associated with your OAuth client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "description": { "content": "OAuth grant type. Send `client_credentials`.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "Requested access scope. Send `ACCOUNT` for the Account API.", "type": "text/plain" }, "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" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "OAuth client identifier issued to your organization.", "type": "text/plain" }, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "description": { "content": "Secret associated with your OAuth client credentials.", "type": "text/plain" }, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "description": { "content": "OAuth grant type. Send `client_credentials`.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "Requested access scope. Send `ACCOUNT` for the Account API.", "type": "text/plain" }, "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": "Your Axiym accounts and balances.", "type": "text/plain" }, "item": [ { "name": "List accounts", "request": { "name": "List accounts", "description": { "content": "Returns your organization's Axiym accounts. Each account holds a balance in one currency on one payment rail.\n\nUse the optional filters to narrow the results 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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get account", "request": { "name": "Get account", "description": { "content": "Returns the current balance, currency, payment rail, and status of one of your Axiym accounts.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get account statement", "request": { "name": "Get account statement", "description": { "content": "Returns the posted credits and debits for one of your accounts, including its opening balance, closing balance, and movement totals.\n\nUse the statement to reconcile your deposits, conversions, withdrawals, and other ledger movements. The balances follow this equation:\n\n`openingBalance + totalCredited - totalDebited = closingBalance`\n\nIf `from` and `to` are omitted, 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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Address Book", "description": { "content": "External bank accounts and wallets registered in your address book for whitelisting as deposit sources and withdrawal destinations.", "type": "text/plain" }, "item": [ { "name": "List address book entries", "request": { "name": "List address book entries", "description": { "content": "Returns the external bank accounts and wallets registered in your address book, including their current status. Filter the results by currency or status.\n\nAn external account is whitelisted for deposits and withdrawals when its status is `ACTIVE`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Add a bank account", "request": { "name": "Add a bank account", "description": { "content": "Registers an external bank account in your organization's address book for whitelisting.\n\nThe entry starts in `PENDING_REVIEW` while Axiym performs due diligence and compliance checks. Once approved, its status becomes `ACTIVE` and it can fund deposits and receive withdrawals. The `destination.activated` webhook reports activation.", "type": "text/plain" }, "url": { "path": [ "address-book", "bank-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 \"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}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "External bank account registered and awaiting due diligence and compliance checks.", "originalRequest": { "url": { "path": [ "address-book", "bank-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"destinationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"PENDING_REVIEW\",\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" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "address-book", "bank-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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}", "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" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "address-book", "bank-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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}", "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": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "address-book", "bank-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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}", "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 failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "address-book", "bank-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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}", "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" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "address-book", "bank-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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}", "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": "Add a wallet address", "request": { "name": "Add a wallet address", "description": { "content": "Registers an external wallet in your organization's address book for whitelisting.\n\nThe entry starts in `PENDING_REVIEW` while Axiym performs due diligence and compliance checks. Once approved, its status becomes `ACTIVE` and it can fund deposits and receive withdrawals. The `destination.activated` webhook reports activation.", "type": "text/plain" }, "url": { "path": [ "address-book", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 \"currency\": \"USD\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "External wallet registered and awaiting due diligence and compliance checks.", "originalRequest": { "url": { "path": [ "address-book", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"destinationId\": \"e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c\",\n \"status\": \"PENDING_REVIEW\",\n \"currency\": \"USDT\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\",\n \"createdAt\": \"2026-06-12T14:05:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "address-book", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\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" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "address-book", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\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": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "address-book", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\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 failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "address-book", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\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" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "address-book", "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"currency\": \"USD\",\n \"walletAddress\": \"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL\",\n \"network\": \"TRON\"\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 an address book entry", "request": { "name": "Get an address book entry", "description": { "content": "Returns a registered external bank account or wallet, including its current status and payment details. Its address book identifier is `destinationId`.\n\nAn external account is whitelisted for deposits and withdrawals when its status 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) Identifier of the external account in your address book (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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) Identifier of the external account in your address book (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"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" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Identifier of the external account in your address book (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Identifier of the external account in your address book (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Identifier of the external account in your address book (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Identifier of the external account in your address book (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Identifier of the external account in your address book (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "address-book", ":destinationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "e2c8a4f6-7b1d-4e3a-9c5f-8a0b2d4e6f1c", "key": "destinationId", "description": "(Required) Identifier of the external account in your address book (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "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 a whitelisted external bank account or wallet with status `ACTIVE` in your address book. Registration is followed by due diligence and compliance checks before activation.\n\n**Instruction type**\n\nReturns one instruction per transfer scheme the account accepts (`scheme`). Use the instruction for the scheme you send with.\n\n- Bank instructions contain the beneficiary, the account number and the receiving bank for the scheme, an intermediary bank when the transfer passes through one, and, when present, an account-specific `reference`. Include the reference on the transfer.\n- Wallet instructions (`BLOCKCHAIN`) contain the receiving beneficiary name, the wallet address, and the 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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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, one per transfer scheme.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"scheme\": \"SWIFT\",\n \"beneficiaryName\": \"Axi Labs AG\",\n \"beneficiaryAddress\": {\n \"streetName\": \"Baarerstrasse\",\n \"buildingNumber\": \"12\",\n \"city\": \"Zug\",\n \"postalCode\": \"6300\",\n \"region\": \"Zug\",\n \"country\": \"CH\"\n },\n \"accountNumber\": \"600000000\",\n \"swiftBic\": \"ZEITPRSJXXX\",\n \"bankName\": \"Zenus Bank International Inc\",\n \"bankAddress\": {\n \"streetName\": \"Zenus Tower, 19th Floor, 252 Ponce de Leon\",\n \"city\": \"San Juan\",\n \"postalCode\": \"00918\",\n \"country\": \"PR\"\n },\n \"intermediaryBank\": {\n \"swiftBic\": \"CHASUS33XXX\",\n \"clearingCode\": \"021000021\",\n \"clearingSystemCode\": \"USABA\",\n \"bankName\": \"JP Morgan Chase NA\",\n \"bankAddress\": {\n \"city\": \"New York\",\n \"region\": \"NY\",\n \"country\": \"US\"\n }\n },\n \"reference\": \"RF11 0004 4901 01\"\n },\n {\n \"scheme\": \"FEDWIRE\",\n \"beneficiaryName\": \"Axi Labs AG\",\n \"beneficiaryAddress\": {\n \"streetName\": \"Baarerstrasse\",\n \"buildingNumber\": \"12\",\n \"city\": \"Zug\",\n \"postalCode\": \"6300\",\n \"region\": \"Zug\",\n \"country\": \"CH\"\n },\n \"accountNumber\": \"30000000000000\",\n \"clearingCode\": \"021000021\",\n \"clearingSystemCode\": \"USABA\",\n \"bankName\": \"JP Morgan Chase NA\",\n \"bankAddress\": {\n \"city\": \"New York\",\n \"region\": \"NY\",\n \"country\": \"US\"\n },\n \"reference\": \"RF11 0004 4901 01\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List deposits", "request": { "name": "List deposits", "description": { "content": "Returns incoming payments detected for your Axiym accounts. Deposits are accepted only from whitelisted external accounts with status `ACTIVE` 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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get deposit", "request": { "name": "Get deposit", "description": { "content": "Returns one incoming payment, including its current status, receiving Axiym account, amount, currency, and available bank or blockchain details. A deposit is credited to the account when its status is `COMPLETED`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Conversions", "description": { "content": "Currency conversions between your permitted Axiym accounts.", "type": "text/plain" }, "item": [ { "name": "List conversion pairs", "request": { "name": "List conversion pairs", "description": { "content": "Returns the conversion directions available to you. Each pair defines the sell currency, buy currency, payment rails, and minimum sell amount.\n\nUse `pairId` when creating a conversion. The reverse direction requires a separate pair.", "type": "text/plain" }, "url": { "path": [ "conversion-pairs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Conversion pairs.", "originalRequest": { "url": { "path": [ "conversion-pairs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"pair\": \"USD-USDT\",\n \"sell\": {\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"buy\": {\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"minAmount\": \"100.00\"\n },\n {\n \"pairId\": \"2b8d0c4e-6f1a-4d3c-8e5b-9a7c3f0d2e4a\",\n \"pair\": \"USDT-USD\",\n \"sell\": {\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"buy\": {\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"minAmount\": \"100.00\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "conversion-pairs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "conversion-pairs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "conversion-pairs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "conversion-pairs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "conversion-pairs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List conversions", "request": { "name": "List conversions", "description": { "content": "Returns the confirmed conversions you created. Filter the results by status or `externalReference`.\nAn unconfirmed `PENDING` conversion appears only in the create response and is not included in this list.", "type": "text/plain" }, "url": { "path": [ "conversions" ], "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": "status", "value": "PENDING", "description": "Filter by status." }, { "disabled": true, "key": "externalReference", "value": "conv-2026-0714-01", "description": "Filter by your external reference." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Page of conversions.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "conv-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"conversionId\": \"a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f\",\n \"status\": \"COMPLETED\",\n \"sellAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"sellAmount\": {\n \"amount\": \"10000.00\",\n \"currency\": \"USD\"\n },\n \"buyAccount\": {\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"buyAmount\": {\n \"amount\": \"9985.00\",\n \"currency\": \"USDT\"\n },\n \"rate\": \"1.00\",\n \"fee\": {\n \"amount\": \"15.00\",\n \"currency\": \"USD\"\n },\n \"externalReference\": \"conv-2026-0714-01\",\n \"createdAt\": \"2026-07-14T14:00:11Z\",\n \"completedAt\": \"2026-07-14T14:05:39Z\"\n },\n {\n \"conversionId\": \"b8e6c2a4-5d1f-4e9b-a7c3-6f2d8b0a4e1c\",\n \"status\": \"ACTIVE\",\n \"sellAccount\": {\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"sellAmount\": {\n \"amount\": \"5000.00\",\n \"currency\": \"USDT\"\n },\n \"buyAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"buyAmount\": {\n \"amount\": \"4992.50\",\n \"currency\": \"USD\"\n },\n \"rate\": \"1.00\",\n \"fee\": {\n \"amount\": \"7.50\",\n \"currency\": \"USD\"\n },\n \"externalReference\": \"conv-2026-0714-02\",\n \"createdAt\": \"2026-07-14T14:05:44Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "conv-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "conv-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "conv-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "conv-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "PENDING" }, { "key": "externalReference", "value": "conv-2026-0714-01" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create conversion", "request": { "name": "Create conversion", "description": { "content": "Creates a conversion quote. Provide a permitted `pairId` and the amount to sell. The pair determines the sell and buy accounts.\nThe response locks the rate and returns the expected `buyAmount`, fee, and expiry time with status `PENDING`.\nConfirm the conversion before it expires to begin execution. An unconfirmed conversion does not execute and cannot be retrieved later.", "type": "text/plain" }, "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"sellAmount\": \"10000.00\",\n \"externalReference\": \"conv-2026-0714-01\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Conversion created with a locked rate, awaiting confirmation.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"sellAmount\": \"10000.00\",\n \"externalReference\": \"conv-2026-0714-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"conversionId\": \"a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f\",\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"status\": \"PENDING\",\n \"sellAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"sellAmount\": {\n \"amount\": \"10000.00\",\n \"currency\": \"USD\"\n },\n \"buyAccount\": {\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"buyAmount\": {\n \"amount\": \"9985.00\",\n \"currency\": \"USDT\"\n },\n \"rate\": \"1.00\",\n \"fee\": {\n \"amount\": \"15.00\",\n \"currency\": \"USD\"\n },\n \"externalReference\": \"conv-2026-0714-01\",\n \"createdAt\": \"2026-07-14T14:00:11Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"sellAmount\": \"10000.00\",\n \"externalReference\": \"conv-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" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"sellAmount\": \"10000.00\",\n \"externalReference\": \"conv-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": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"sellAmount\": \"10000.00\",\n \"externalReference\": \"conv-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" }, { "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"sellAmount\": \"10000.00\",\n \"externalReference\": \"conv-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 failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"sellAmount\": \"10000.00\",\n \"externalReference\": \"conv-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" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"sellAmount\": \"10000.00\",\n \"externalReference\": \"conv-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 conversion", "request": { "name": "Get conversion", "description": { "content": "Returns one confirmed conversion, including its status, sell and buy accounts, amounts, locked rate, and fee.\nAn unconfirmed `PENDING` conversion is available only in the create response.", "type": "text/plain" }, "url": { "path": [ "conversions", ":conversionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Conversion.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"conversionId\": \"a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f\",\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"status\": \"COMPLETED\",\n \"sellAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"sellAmount\": {\n \"amount\": \"10000.00\",\n \"currency\": \"USD\"\n },\n \"buyAccount\": {\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"buyAmount\": {\n \"amount\": \"9985.00\",\n \"currency\": \"USDT\"\n },\n \"rate\": \"1.00\",\n \"fee\": {\n \"amount\": \"15.00\",\n \"currency\": \"USD\"\n },\n \"externalReference\": \"conv-2026-0714-01\",\n \"createdAt\": \"2026-07-14T14:00:11Z\",\n \"completedAt\": \"2026-07-14T14:05:39Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Confirm conversion", "request": { "name": "Confirm conversion", "description": { "content": "Accepts the locked quote for a `PENDING` conversion and begins execution.\nConfirm before the quote expires. If it has expired, create a new conversion.", "type": "text/plain" }, "url": { "path": [ "conversions", ":conversionId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Conversion confirmed and executing.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 \"conversionId\": \"a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f\",\n \"pairId\": \"7c9e1a3b-5d2f-4e8a-9b0c-6d4f2a8e1c3b\",\n \"status\": \"ACTIVE\",\n \"sellAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"sellAmount\": {\n \"amount\": \"10000.00\",\n \"currency\": \"USD\"\n },\n \"buyAccount\": {\n \"accountId\": \"8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a\",\n \"currency\": \"USDT\",\n \"paymentRails\": \"TRON\"\n },\n \"buyAmount\": {\n \"amount\": \"9985.00\",\n \"currency\": \"USDT\"\n },\n \"rate\": \"1.00\",\n \"fee\": {\n \"amount\": \"15.00\",\n \"currency\": \"USD\"\n },\n \"externalReference\": \"conv-2026-0714-01\",\n \"createdAt\": \"2026-07-14T14:00:11Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "conversions", ":conversionId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a3f5d7c9-1e2b-4c6a-8d9f-0b1a2c3d4e5f", "key": "conversionId", "description": "(Required) Conversion identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": "Withdrawals", "description": { "content": "Outgoing funds from your Axiym accounts.", "type": "text/plain" }, "item": [ { "name": "List withdrawals", "request": { "name": "List withdrawals", "description": { "content": "Returns the withdrawals you created. Filter the results 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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"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 \"status\": \"PENDING\",\n \"createdAt\": \"2026-07-14T20:06:50Z\",\n \"code\": \"AXI00000418\",\n \"reference\": \"Treasury sweep\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"c7a760d0-946a-712e-e80c-e2bfd3b91abd\",\n \"name\": \"string\",\n \"contentType\": \"application/pdf\",\n \"size\": 3016\n },\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"61546446-5a57-17cf-f7c3-55398b429ce5\",\n \"name\": \"string\",\n \"contentType\": \"application/pdf\",\n \"size\": 2112\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 \"status\": \"PENDING\",\n \"createdAt\": \"2026-07-14T20:06:50Z\",\n \"code\": \"AXI00000418\",\n \"reference\": \"Treasury sweep\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"735b24ff-6944-7af3-b1ab-59dddbd69edd\",\n \"name\": \"string\",\n \"contentType\": \"application/pdf\",\n \"size\": 3373\n },\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"e0122478-8d15-fea8-d2a3-927532313672\",\n \"name\": \"string\",\n \"contentType\": \"application/pdf\",\n \"size\": 8660\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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create withdrawal", "request": { "name": "Create withdrawal", "description": { "content": "Creates a withdrawal from your Axiym account to a whitelisted external bank account or wallet.\n\n**Requirements**\n\n- `sourceAccountId` must identify an Axiym account belonging to your organization.\n- `destinationId` must identify an external account registered in your organization's address book.\n- The source Axiym account and the external account must both be `ACTIVE` and use the same currency.\n\nThe response includes the withdrawal, source account, 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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 one withdrawal, including its current status, source account, destination, amounts, fee, and any available bank or blockchain details.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "The request is malformed or cannot be processed as supplied.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "Authentication is missing or invalid.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": "Your access token does not permit this operation or access to the requested resource.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "The requested resource was not found.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "An unexpected server error prevented the request from completing.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 subscriptions and signing keys.", "type": "text/plain" }, "item": [ { "name": "List webhook subscriptions", "request": { "name": "List webhook subscriptions", "description": { "content": "Returns the active webhook endpoints registered for your organization. Use pagination to retrieve additional subscriptions when present.", "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 identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "name": "Active webhook subscriptions and pagination details.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"nodes\": [\n {\n \"subscriptionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"endpoint\": \"https://api.acme.example/webhooks\"\n },\n {\n \"subscriptionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"endpoint\": \"https://api.acme.example/webhooks\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create webhook subscription", "request": { "name": "Create webhook subscription", "description": { "content": "Registers a publicly reachable HTTPS endpoint to receive webhook notifications available to your organization. A subscription applies to the endpoint as a whole and does not define per-event filters. Store the returned `subscriptionId` for testing or disabling the subscription.", "type": "text/plain" }, "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": [ { "name": "Webhook subscription created.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": "Requests a signed test delivery to the endpoint registered for the specified subscription. Use this to verify endpoint reachability, signature validation, event persistence, and successful `2xx` acknowledgement. A successful API response means the test request was accepted, not that your endpoint processed the delivery successfully.", "type": "text/plain" }, "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": [ { "name": "Test delivery request accepted. This response does not confirm successful delivery or processing by your endpoint.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) A unique key for safely retrying this request. Reuse the same key with the same request method, endpoint, and payload to obtain the original result without repeating the operation. Use a new key for each new operation, including separate keys for creation and confirmation. A UUID is recommended.", "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 the specified webhook subscription. Its endpoint stops receiving new event deliveries, and the subscription is no longer returned when listing active subscriptions.", "type": "text/plain" }, "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "name": "Webhook subscription disabled.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"endpoint\": \"https://api.acme.example/webhooks\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get webhook public key", "request": { "name": "Get webhook public key", "description": { "content": "Returns the Ed25519 public key identified by the `X-Key-Id` header on a webhook delivery. Use this key to verify the `X-Signature` value against the raw request body. Cache keys by `publicKeyId` and retrieve a new key when an unfamiliar identifier is received.", "type": "text/plain" }, "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0b7d9e2f-3c4a-4b5d-9e6f-7a8b9c0d1e2f", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] } }, "response": [ { "name": "Public key for verifying webhook signatures.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0b7d9e2f-3c4a-4b5d-9e6f-7a8b9c0d1e2f", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"publicKeyId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"algorithm\": \"ED25519\",\n \"publicKey\": \"string\",\n \"createdAt\": \"2026-07-14T20:08:00Z\",\n \"active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request is malformed or cannot be processed as supplied.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0b7d9e2f-3c4a-4b5d-9e6f-7a8b9c0d1e2f", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errors\": {\n \"message\": \"Failed to parse the request body as JSON: expected value at line 1 column 5\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Authentication is missing or invalid.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0b7d9e2f-3c4a-4b5d-9e6f-7a8b9c0d1e2f", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Your access token does not permit this operation or access to the requested resource.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0b7d9e2f-3c4a-4b5d-9e6f-7a8b9c0d1e2f", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The requested resource was not found.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0b7d9e2f-3c4a-4b5d-9e6f-7a8b9c0d1e2f", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "The request failed validation or a business rule. Validation failures return `errors` keyed by request field. Business rejections return `errors: null` and explain the reason in `message`.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0b7d9e2f-3c4a-4b5d-9e6f-7a8b9c0d1e2f", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"legalEntityName\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "An unexpected server error prevented the request from completing.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0b7d9e2f-3c4a-4b5d-9e6f-7a8b9c0d1e2f", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the `X-Request-Id` response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.\n", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://partner-api.sandbox.axiym.io/api/v1", "key": "baseUrl" }, { "key": "clientId", "value": "", "type": "string" }, { "key": "clientSecret", "value": "", "type": "string" }, { "key": "accessToken", "value": "", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}" } ] }, "info": { "name": "Axiym Account API v0.1.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Use the Account API to manage your organization's Axiym accounts: view balances and statements, register external bank accounts and wallets, deposit funds, convert currencies, and make withdrawals. The access token identifies your organization and provides access to its API resources.\n\nSubscribe to webhooks to receive notifications about account movements and changes to deposits, conversions, withdrawals, and registered external accounts.\n\nGenerated from /openapi/account-api/0.1.0.yaml. API version: 0.1.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." } }