{ "item": [ { "name": "Auth", "description": { "content": "OAuth 2.0 authentication for your integration.", "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 `PAYMENT` scope and send the returned token as a bearer token on subsequent Payment API requests.", "type": "text/plain" }, "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "noauth" }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PAYMENT" } ] } }, "response": [ { "name": "Access token issued.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PAYMENT" } ] }, "auth": { "type": "noauth" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token_type\": \"string\",\n \"expires_in\": 350,\n \"access_token\": \"string\",\n \"scope\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PAYMENT" } ] }, "auth": { "type": "noauth" } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PAYMENT" } ] }, "auth": { "type": "noauth" } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Unexpected server error.", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "client_id", "value": "{{clientId}}" }, { "disabled": false, "key": "client_secret", "value": "{{clientSecret}}" }, { "disabled": false, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "key": "scope", "value": "PAYMENT" } ] }, "auth": { "type": "noauth" } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "pm.collectionVariables.set(\"accessToken\", \"\");" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.collectionVariables.set(\"accessToken\", \"\");", "if (pm.response.code >= 200 && pm.response.code < 300) {", " const body = pm.response.json();", " pm.test(\"Access token returned\", function () {", " pm.expect(body.access_token).to.be.a(\"string\").and.not.empty;", " });", " if (typeof body.access_token === \"string\" && body.access_token.trim()) {", " pm.collectionVariables.set(\"accessToken\", body.access_token);", " }", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Accounts", "description": { "content": "Axiym accounts and balances available to fund payments.", "type": "text/plain" }, "item": [ { "name": "List accounts", "request": { "name": "List accounts", "description": { "content": "Returns the Axiym accounts accessible to your integration. Each holds a balance in one currency and is connected to a payment rail.\n\nFilter by currency or account status. Account funding is arranged outside the Payment API.", "type": "text/plain" }, "url": { "path": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "first", "value": "20", "description": "Maximum number of items to return (page size)." }, { "disabled": true, "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==", "description": "Cursor for the next page, from the previous response's pageInfo.endCursor." }, { "disabled": true, "key": "currency", "value": "USD", "description": "Filter by currency." }, { "disabled": true, "key": "status", "value": "ACTIVE", "description": "Filter by status." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "accounts" ], "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "accounts" ], "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "accounts" ], "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "currency", "value": "USD" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "accounts" ], "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 balance, currency, payment rail, and status of an Axiym account accessible to your integration.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get account statement", "request": { "name": "Get account statement", "description": { "content": "Returns posted credits and debits for an Axiym account, with opening and closing balances and movement totals. Funding reservations are not posted debits; the payment debit appears at settlement.\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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"type\": \"DEBIT\",\n \"amount\": \"1010.00\",\n \"currency\": \"USD\",\n \"balanceAfter\": \"47240.00\",\n \"occurredAt\": \"2026-09-07T10:12:00Z\",\n \"balanceBefore\": \"48250.00\",\n \"relatedResourceType\": \"PAYOUT\",\n \"relatedResourceId\": \"c3d65312-6575-43de-b8ae-728d8d0a9371\"\n },\n {\n \"entryId\": \"7f9a2d1c-8b31-4f59-9e2f-1d63c4a27b12\",\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"type\": \"DEBIT\",\n \"amount\": \"1010.00\",\n \"currency\": \"USD\",\n \"balanceAfter\": \"47240.00\",\n \"occurredAt\": \"2026-09-07T10:12:00Z\",\n \"balanceBefore\": \"48250.00\",\n \"relatedResourceType\": \"PAYOUT\",\n \"relatedResourceId\": \"c3d65312-6575-43de-b8ae-728d8d0a9371\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "accounts", ":accountId", "statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "from", "value": "2026-06-01" }, { "key": "to", "value": "2026-06-30" }, { "key": "type", "value": "DEBIT" } ], "variable": [ { "disabled": false, "type": "any", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "accountId", "description": "(Required) Account identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Corridors", "description": { "content": "Payment corridors available to your integration.", "type": "text/plain" }, "item": [ { "name": "List payment corridors", "request": { "name": "List payment corridors", "description": { "content": "Lists the payment corridors configured for your integration and their current availability. A corridor combines the funding currency, destination country, and destination currency.\n\nUse the optional filters to narrow the results. Without filters, the endpoint returns every configured corridor.", "type": "text/plain" }, "url": { "path": [ "corridors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "sourceCurrency", "value": "USD", "description": "Filter by funding currency." }, { "disabled": true, "key": "destinationCountry", "value": "US", "description": "Filter by ISO 3166-1 alpha-2 destination country." }, { "disabled": true, "key": "destinationCurrency", "value": "USD", "description": "Filter by destination currency." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Payout corridors", "originalRequest": { "url": { "path": [ "corridors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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 \"sourceCurrency\": \"USD\",\n \"destinationCountry\": \"PH\",\n \"destinationCurrency\": \"USD\",\n \"availability\": \"AVAILABLE\"\n },\n {\n \"sourceCurrency\": \"USD\",\n \"destinationCountry\": \"PH\",\n \"destinationCurrency\": \"USD\",\n \"availability\": \"AVAILABLE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "corridors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "corridors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "corridors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "corridors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "corridors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "corridors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 payment corridor details", "request": { "name": "Get payment corridor details", "description": { "content": "Returns availability, amount limits, and destination-specific data and compliance requirements for the selected corridor. Apply these alongside the baseline requirements in the payout schemas.\n\nIdentify the corridor using `sourceCurrency`, `destinationCountry`, and `destinationCurrency`.", "type": "text/plain" }, "url": { "path": [ "corridors", "details" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sourceCurrency", "value": "USD", "description": "(Required) Funding currency." }, { "disabled": false, "key": "destinationCountry", "value": "US", "description": "(Required) ISO 3166-1 alpha-2 destination country." }, { "disabled": false, "key": "destinationCurrency", "value": "USD", "description": "(Required) Destination currency to be delivered to the beneficiary." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Payout corridor details", "originalRequest": { "url": { "path": [ "corridors", "details" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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 \"amountLimits\": {\n \"minimum\": {\n \"amount\": \"100.00\",\n \"currency\": \"PHP\"\n },\n \"maximum\": {\n \"amount\": \"500000.00\",\n \"currency\": \"PHP\"\n }\n },\n \"availability\": \"AVAILABLE\",\n \"destinationCountry\": \"PH\",\n \"destinationCurrency\": \"USD\",\n \"requirements\": {\n \"fields\": [\n {\n \"field\": \"recipient.destination.bank.clearingCode\",\n \"label\": \"Bank routing number\",\n \"requiredness\": \"OPTIONAL\",\n \"format\": \"9 digits\",\n \"description\": \"string\",\n \"pattern\": \"^[0-9]{9}$\",\n \"normalization\": \"Remove whitespace\"\n },\n {\n \"field\": \"recipient.destination.bank.clearingCode\",\n \"label\": \"Bank routing number\",\n \"requiredness\": \"OPTIONAL\",\n \"format\": \"9 digits\",\n \"description\": \"string\",\n \"pattern\": \"^[0-9]{9}$\",\n \"normalization\": \"Remove whitespace\"\n }\n ],\n \"complianceInformation\": [\n \"string\",\n \"string\"\n ]\n },\n \"sourceCurrency\": \"USD\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "corridors", "details" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "corridors", "details" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "corridors", "details" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "corridors", "details" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "corridors", "details" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "corridors", "details" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sourceCurrency", "value": "USD" }, { "key": "destinationCountry", "value": "US" }, { "key": "destinationCurrency", "value": "USD" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Payouts", "description": { "content": "Create, review, confirm, and track outgoing payments.", "type": "text/plain" }, "item": [ { "name": "List payouts", "request": { "name": "List payouts", "description": { "content": "Returns payouts using the common payment response document, including payouts awaiting confirmation. Filter by funding account, `externalReference`, or status.", "type": "text/plain" }, "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "accountId", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "description": "Filter by funding account identifier." }, { "disabled": true, "key": "externalReference", "value": "string", "description": "Filter by the reference supplied when the payout was created." }, { "disabled": true, "key": "status", "value": "PENDING_CONFIRMATION", "description": "Filter by payout status." }, { "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Payout page", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountId", "value": "f407a69a-910a-a060-b376-b195a9612c7a" }, { "key": "externalReference", "value": "string" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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 \"paymentId\": \"c3d65312-6575-43de-b8ae-728d8d0a9371\",\n \"code\": \"AXI00000420\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"sourceAmount\": {\n \"amount\": \"1010.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"10.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"rate\": \"56.5000\",\n \"termsExpireAt\": \"2026-09-07T10:05:00Z\",\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"fileId\": \"6c1d0e42-8b7a-4f39-9d21-3a5e7c9b1f08\",\n \"name\": \"acme-registry-extract.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 96311\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"contact\": {\n \"email\": \"accounts@manilasoftware.example\",\n \"phoneNumber\": \"+639171234567\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"0f6a2c91-4b7e-4d31-9c58-2e8a1f6b3d40\",\n \"name\": \"INV-2026-0917.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 184233\n }\n ],\n \"createdAt\": \"2026-09-07T10:00:00Z\",\n \"updatedAt\": \"2026-09-07T10:00:00Z\"\n },\n {\n \"paymentId\": \"c3d65312-6575-43de-b8ae-728d8d0a9371\",\n \"code\": \"AXI00000420\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"sourceAmount\": {\n \"amount\": \"1010.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"10.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"rate\": \"56.5000\",\n \"termsExpireAt\": \"2026-09-07T10:05:00Z\",\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"fileId\": \"6c1d0e42-8b7a-4f39-9d21-3a5e7c9b1f08\",\n \"name\": \"acme-registry-extract.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 96311\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"contact\": {\n \"email\": \"accounts@manilasoftware.example\",\n \"phoneNumber\": \"+639171234567\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"0f6a2c91-4b7e-4d31-9c58-2e8a1f6b3d40\",\n \"name\": \"INV-2026-0917.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 184233\n }\n ],\n \"createdAt\": \"2026-09-07T10:00:00Z\",\n \"updatedAt\": \"2026-09-07T10:00:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountId", "value": "f407a69a-910a-a060-b376-b195a9612c7a" }, { "key": "externalReference", "value": "string" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountId", "value": "f407a69a-910a-a060-b376-b195a9612c7a" }, { "key": "externalReference", "value": "string" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountId", "value": "f407a69a-910a-a060-b376-b195a9612c7a" }, { "key": "externalReference", "value": "string" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountId", "value": "f407a69a-910a-a060-b376-b195a9612c7a" }, { "key": "externalReference", "value": "string" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "accountId", "value": "f407a69a-910a-a060-b376-b195a9612c7a" }, { "key": "externalReference", "value": "string" }, { "key": "status", "value": "PENDING_CONFIRMATION" }, { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 a payout", "request": { "name": "Create a payout", "description": { "content": "Creates a payout using Axiym field names and exact controlled-value codes. Non-canonical labels are rejected. To use your own field structure or value labels, store a Payment Data Map and use POST /payouts/mapped.\n\nAxiym validates corridor availability, amount limits, and payment requirements, applies any documented deterministic formatting rules, and calculates commercial terms.\n\nCreation returns the prepared instruction and commercial terms in PENDING_CONFIRMATION. It does not reserve funds or start processing. Review the returned document, then confirm it before termsExpireAt.", "type": "text/plain" }, "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"name\": \"acme-registry-extract.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"name\": \"INV-2026-0917.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Payout created with status PENDING_CONFIRMATION and commercial terms valid until termsExpireAt.", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"name\": \"acme-registry-extract.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"name\": \"INV-2026-0917.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentId\": \"c3d65312-6575-43de-b8ae-728d8d0a9371\",\n \"code\": \"AXI00000420\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"sourceAmount\": {\n \"amount\": \"1010.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"10.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"rate\": \"56.5000\",\n \"termsExpireAt\": \"2026-09-07T10:05:00Z\",\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"fileId\": \"6c1d0e42-8b7a-4f39-9d21-3a5e7c9b1f08\",\n \"name\": \"acme-registry-extract.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 96311\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"contact\": {\n \"email\": \"accounts@manilasoftware.example\",\n \"phoneNumber\": \"+639171234567\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"0f6a2c91-4b7e-4d31-9c58-2e8a1f6b3d40\",\n \"name\": \"INV-2026-0917.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 184233\n }\n ],\n \"createdAt\": \"2026-09-07T10:00:00Z\",\n \"updatedAt\": \"2026-09-07T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"name\": \"acme-registry-extract.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"name\": \"INV-2026-0917.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"name\": \"acme-registry-extract.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"name\": \"INV-2026-0917.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"name\": \"acme-registry-extract.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"name\": \"INV-2026-0917.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"name\": \"acme-registry-extract.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"name\": \"INV-2026-0917.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"name\": \"acme-registry-extract.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"name\": \"INV-2026-0917.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"sourceAccountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"name\": \"acme-registry-extract.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"name\": \"INV-2026-0917.pdf\",\n \"data\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 a payout with mapped data", "request": { "name": "Create a payout with mapped data", "description": { "content": "Creates a payout from one payment object using the immutable definition identified by paymentDataMapId. All source paths are relative to payment. The map must be ACTIVE; an archived map is rejected with HTTP 422.\n\nAxiym applies the saved field mappings, connects documents through nesting or exact ID matches and filters, and translates controlled labels. Exact Axiym codes pass unchanged. Other values must match a saved label exactly, including case and whitespace. Each array entry is processed independently. Missing optional paths are omitted; unmapped source fields are ignored. Ambiguous or unmatched files in a configured document collection are rejected.\n\nThe map also determines sender handling and the fixed amount side. A map using onboarded-profile uses the account holder profile and skips sender rules. A map using supplied requires the mapped sender data. Amount resolution uses the mapped amount currency, the Axiym funding account currency, and the recipient destination currency, or the saved fixed-side rule.\n\nThe resulting data must satisfy the strict PayoutRequest schema and current corridor requirements. Unknown labels, missing required data, incompatible source types, and invalid document or currency associations are rejected with HTTP 422. Axiym then calculates commercial terms.\n\nCreation returns the prepared instruction and commercial terms in PENDING_CONFIRMATION. It does not reserve funds or start processing. Review the returned instruction, then confirm it before termsExpireAt. Confirmation uses the stored instruction without rerunning the map.", "type": "text/plain" }, "url": { "path": [ "payouts", "mapped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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 \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\",\n \"payment\": {\n \"instruction\": {\n \"account\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"total\": \"1000.00\",\n \"currency\": \"USD\",\n \"reason\": \"supplier invoice\",\n \"funding\": \"business income\",\n \"reference\": \"INV-1042\"\n },\n \"beneficiary\": {\n \"name\": \"Example Supplier Corporation\",\n \"relationship\": \"supplier\",\n \"address\": {\n \"line\": \"Ayala Avenue\",\n \"city\": \"Makati\",\n \"country\": \"PH\"\n },\n \"account\": {\n \"number\": \"1234567890\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"name\": \"Example Bank\",\n \"swift\": \"BNORPHMM\",\n \"country\": \"PH\"\n }\n }\n },\n \"files\": [\n {\n \"ownerId\": \"INV-1042\",\n \"usage\": \"payment\",\n \"kind\": \"invoice\",\n \"fileName\": \"INV-1042.pdf\",\n \"content\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Payout created with status PENDING_CONFIRMATION and commercial terms valid until termsExpireAt.", "originalRequest": { "url": { "path": [ "payouts", "mapped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\",\n \"payment\": {\n \"instruction\": {\n \"account\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"total\": \"1000.00\",\n \"currency\": \"USD\",\n \"reason\": \"supplier invoice\",\n \"funding\": \"business income\",\n \"reference\": \"INV-1042\"\n },\n \"beneficiary\": {\n \"name\": \"Example Supplier Corporation\",\n \"relationship\": \"supplier\",\n \"address\": {\n \"line\": \"Ayala Avenue\",\n \"city\": \"Makati\",\n \"country\": \"PH\"\n },\n \"account\": {\n \"number\": \"1234567890\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"name\": \"Example Bank\",\n \"swift\": \"BNORPHMM\",\n \"country\": \"PH\"\n }\n }\n },\n \"files\": [\n {\n \"ownerId\": \"INV-1042\",\n \"usage\": \"payment\",\n \"kind\": \"invoice\",\n \"fileName\": \"INV-1042.pdf\",\n \"content\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentId\": \"c3d65312-6575-43de-b8ae-728d8d0a9371\",\n \"code\": \"AXI00000420\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"sourceAmount\": {\n \"amount\": \"1010.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"10.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"rate\": \"56.5000\",\n \"termsExpireAt\": \"2026-09-07T10:05:00Z\",\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"fileId\": \"6c1d0e42-8b7a-4f39-9d21-3a5e7c9b1f08\",\n \"name\": \"acme-registry-extract.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 96311\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"contact\": {\n \"email\": \"accounts@manilasoftware.example\",\n \"phoneNumber\": \"+639171234567\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"0f6a2c91-4b7e-4d31-9c58-2e8a1f6b3d40\",\n \"name\": \"INV-2026-0917.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 184233\n }\n ],\n \"createdAt\": \"2026-09-07T10:00:00Z\",\n \"updatedAt\": \"2026-09-07T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payouts", "mapped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\",\n \"payment\": {\n \"instruction\": {\n \"account\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"total\": \"1000.00\",\n \"currency\": \"USD\",\n \"reason\": \"supplier invoice\",\n \"funding\": \"business income\",\n \"reference\": \"INV-1042\"\n },\n \"beneficiary\": {\n \"name\": \"Example Supplier Corporation\",\n \"relationship\": \"supplier\",\n \"address\": {\n \"line\": \"Ayala Avenue\",\n \"city\": \"Makati\",\n \"country\": \"PH\"\n },\n \"account\": {\n \"number\": \"1234567890\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"name\": \"Example Bank\",\n \"swift\": \"BNORPHMM\",\n \"country\": \"PH\"\n }\n }\n },\n \"files\": [\n {\n \"ownerId\": \"INV-1042\",\n \"usage\": \"payment\",\n \"kind\": \"invoice\",\n \"fileName\": \"INV-1042.pdf\",\n \"content\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payouts", "mapped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\",\n \"payment\": {\n \"instruction\": {\n \"account\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"total\": \"1000.00\",\n \"currency\": \"USD\",\n \"reason\": \"supplier invoice\",\n \"funding\": \"business income\",\n \"reference\": \"INV-1042\"\n },\n \"beneficiary\": {\n \"name\": \"Example Supplier Corporation\",\n \"relationship\": \"supplier\",\n \"address\": {\n \"line\": \"Ayala Avenue\",\n \"city\": \"Makati\",\n \"country\": \"PH\"\n },\n \"account\": {\n \"number\": \"1234567890\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"name\": \"Example Bank\",\n \"swift\": \"BNORPHMM\",\n \"country\": \"PH\"\n }\n }\n },\n \"files\": [\n {\n \"ownerId\": \"INV-1042\",\n \"usage\": \"payment\",\n \"kind\": \"invoice\",\n \"fileName\": \"INV-1042.pdf\",\n \"content\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payouts", "mapped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\",\n \"payment\": {\n \"instruction\": {\n \"account\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"total\": \"1000.00\",\n \"currency\": \"USD\",\n \"reason\": \"supplier invoice\",\n \"funding\": \"business income\",\n \"reference\": \"INV-1042\"\n },\n \"beneficiary\": {\n \"name\": \"Example Supplier Corporation\",\n \"relationship\": \"supplier\",\n \"address\": {\n \"line\": \"Ayala Avenue\",\n \"city\": \"Makati\",\n \"country\": \"PH\"\n },\n \"account\": {\n \"number\": \"1234567890\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"name\": \"Example Bank\",\n \"swift\": \"BNORPHMM\",\n \"country\": \"PH\"\n }\n }\n },\n \"files\": [\n {\n \"ownerId\": \"INV-1042\",\n \"usage\": \"payment\",\n \"kind\": \"invoice\",\n \"fileName\": \"INV-1042.pdf\",\n \"content\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "payouts", "mapped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\",\n \"payment\": {\n \"instruction\": {\n \"account\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"total\": \"1000.00\",\n \"currency\": \"USD\",\n \"reason\": \"supplier invoice\",\n \"funding\": \"business income\",\n \"reference\": \"INV-1042\"\n },\n \"beneficiary\": {\n \"name\": \"Example Supplier Corporation\",\n \"relationship\": \"supplier\",\n \"address\": {\n \"line\": \"Ayala Avenue\",\n \"city\": \"Makati\",\n \"country\": \"PH\"\n },\n \"account\": {\n \"number\": \"1234567890\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"name\": \"Example Bank\",\n \"swift\": \"BNORPHMM\",\n \"country\": \"PH\"\n }\n }\n },\n \"files\": [\n {\n \"ownerId\": \"INV-1042\",\n \"usage\": \"payment\",\n \"kind\": \"invoice\",\n \"fileName\": \"INV-1042.pdf\",\n \"content\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 map or resulting payout data failed validation. Archived maps return payment_data_map_archived at paymentDataMapId. Unrecognized controlled values return unmapped_value at the original request field. Parameters identify the canonical target path and map. Other validation errors use the standard field-error shape.", "originalRequest": { "url": { "path": [ "payouts", "mapped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\",\n \"payment\": {\n \"instruction\": {\n \"account\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"total\": \"1000.00\",\n \"currency\": \"USD\",\n \"reason\": \"supplier invoice\",\n \"funding\": \"business income\",\n \"reference\": \"INV-1042\"\n },\n \"beneficiary\": {\n \"name\": \"Example Supplier Corporation\",\n \"relationship\": \"supplier\",\n \"address\": {\n \"line\": \"Ayala Avenue\",\n \"city\": \"Makati\",\n \"country\": \"PH\"\n },\n \"account\": {\n \"number\": \"1234567890\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"name\": \"Example Bank\",\n \"swift\": \"BNORPHMM\",\n \"country\": \"PH\"\n }\n }\n },\n \"files\": [\n {\n \"ownerId\": \"INV-1042\",\n \"usage\": \"payment\",\n \"kind\": \"invoice\",\n \"fileName\": \"INV-1042.pdf\",\n \"content\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 422,\n \"message\": \"Invalid Parameters\",\n \"errors\": {\n \"paymentDataMapId\": [\n {\n \"code\": \"payment_data_map_archived\",\n \"message\": \"This map is archived and cannot be used for new payouts.\",\n \"params\": {\n \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payouts", "mapped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"paymentDataMapId\": \"d2a1c7e4-9b3f-4e6a-8c5d-1f0b2a3c4d5e\",\n \"payment\": {\n \"instruction\": {\n \"account\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"total\": \"1000.00\",\n \"currency\": \"USD\",\n \"reason\": \"supplier invoice\",\n \"funding\": \"business income\",\n \"reference\": \"INV-1042\"\n },\n \"beneficiary\": {\n \"name\": \"Example Supplier Corporation\",\n \"relationship\": \"supplier\",\n \"address\": {\n \"line\": \"Ayala Avenue\",\n \"city\": \"Makati\",\n \"country\": \"PH\"\n },\n \"account\": {\n \"number\": \"1234567890\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"name\": \"Example Bank\",\n \"swift\": \"BNORPHMM\",\n \"country\": \"PH\"\n }\n }\n },\n \"files\": [\n {\n \"ownerId\": \"INV-1042\",\n \"usage\": \"payment\",\n \"kind\": \"invoice\",\n \"fileName\": \"INV-1042.pdf\",\n \"content\": \"JVBERi0xLjQKJSBBeGl5bSBleGFtcGxlCg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a payout", "request": { "name": "Get a payout", "description": { "content": "Returns the payout as a flat payment document containing its current status, commercial terms, prepared payment instruction, and any outcome reason.", "type": "text/plain" }, "url": { "path": [ "payouts", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Payout found", "originalRequest": { "url": { "path": [ "payouts", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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 \"paymentId\": \"c3d65312-6575-43de-b8ae-728d8d0a9371\",\n \"code\": \"AXI00000420\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"sourceAmount\": {\n \"amount\": \"1010.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"10.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"rate\": \"56.5000\",\n \"termsExpireAt\": \"2026-09-07T10:05:00Z\",\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"fileId\": \"6c1d0e42-8b7a-4f39-9d21-3a5e7c9b1f08\",\n \"name\": \"acme-registry-extract.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 96311\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"contact\": {\n \"email\": \"accounts@manilasoftware.example\",\n \"phoneNumber\": \"+639171234567\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"0f6a2c91-4b7e-4d31-9c58-2e8a1f6b3d40\",\n \"name\": \"INV-2026-0917.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 184233\n }\n ],\n \"createdAt\": \"2026-09-07T10:00:00Z\",\n \"updatedAt\": \"2026-09-07T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payouts", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "payouts", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 a payout", "request": { "name": "Confirm a payout", "description": { "content": "Confirms a payout in `PENDING_CONFIRMATION`, reserves `sourceAmount` from the funding account, and starts processing the stored payment instruction.\n\nThe request has no body and confirms the stored instruction and commercial terms. Use a new `Idempotency-Key` for confirmation; reuse that key when retrying the same request.\n\nThe terms must not have expired, and the funding account must be active, enabled for payouts, and sufficiently funded. Insufficient funds return `422` and leave the payout in `PENDING_CONFIRMATION` with no reservation. At `termsExpireAt`, an unconfirmed payout automatically moves to `CANCELED` with `reasonCode: TERMS_EXPIRED`; confirmation after that returns `422`.", "type": "text/plain" }, "url": { "path": [ "payouts", ":paymentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Payout confirmed with status PENDING and sourceAmount reserved in the funding account.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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 \"paymentId\": \"c3d65312-6575-43de-b8ae-728d8d0a9371\",\n \"code\": \"AXI00000420\",\n \"sourceAccount\": {\n \"accountId\": \"5c0a9d3e-1f2b-4a6c-8e7d-9b3f5a1c2d4e\",\n \"currency\": \"USD\",\n \"paymentRails\": \"ZENUS_BANK\"\n },\n \"externalReference\": \"PAYOUT-2026-001\",\n \"status\": \"PENDING_CONFIRMATION\",\n \"sourceAmount\": {\n \"amount\": \"1010.00\",\n \"currency\": \"USD\"\n },\n \"fee\": {\n \"amount\": \"10.00\",\n \"currency\": \"USD\"\n },\n \"destinationAmount\": {\n \"amount\": \"56500.00\",\n \"currency\": \"PHP\"\n },\n \"rate\": \"56.5000\",\n \"termsExpireAt\": \"2026-09-07T10:05:00Z\",\n \"sender\": {\n \"name\": \"Acme Pte. Ltd.\",\n \"countryOfIncorporation\": \"SG\",\n \"address\": {\n \"streetName\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n },\n \"contact\": {\n \"email\": \"payments@acme.example\",\n \"phoneNumber\": \"+6591234567\"\n },\n \"identification\": {\n \"type\": \"REGISTRATION_NUMBER\",\n \"number\": \"202612345N\",\n \"country\": \"SG\",\n \"documents\": [\n {\n \"documentType\": \"REGISTRY_EXTRACT\",\n \"fileId\": \"6c1d0e42-8b7a-4f39-9d21-3a5e7c9b1f08\",\n \"name\": \"acme-registry-extract.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 96311\n }\n ]\n },\n \"relationships\": [\n {\n \"role\": \"UBO\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Tan\",\n \"nationalities\": [\n \"SG\"\n ],\n \"address\": {\n \"streetName\": \"10 Anson Road\",\n \"city\": \"Singapore\",\n \"postalCode\": \"079903\",\n \"country\": \"SG\"\n },\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"number\": \"E1234567A\",\n \"country\": \"SG\"\n }\n }\n ]\n },\n \"recipient\": {\n \"businessRelationship\": \"SUPPLIER\",\n \"name\": \"Manila Software Services Inc.\",\n \"countryOfIncorporation\": \"PH\",\n \"address\": {\n \"streetName\": \"6789 Ayala Avenue\",\n \"city\": \"Makati\",\n \"postalCode\": \"1226\",\n \"country\": \"PH\"\n },\n \"contact\": {\n \"email\": \"accounts@manilasoftware.example\",\n \"phoneNumber\": \"+639171234567\"\n },\n \"destination\": {\n \"accountNumber\": \"123456789012\",\n \"currency\": \"PHP\",\n \"bank\": {\n \"bankName\": \"Example Bank Philippines\",\n \"address\": {\n \"country\": \"PH\"\n },\n \"swiftBic\": \"BNORPHMMXXX\"\n }\n }\n },\n \"sourceOfFunds\": \"BUSINESS_INCOME\",\n \"purpose\": \"SERVICES_PAYMENT\",\n \"reference\": \"INV-2026-0917\",\n \"supportingDocuments\": [\n {\n \"documentType\": \"INVOICE\",\n \"fileId\": \"0f6a2c91-4b7e-4d31-9c58-2e8a1f6b3d40\",\n \"name\": \"INV-2026-0917.pdf\",\n \"contentType\": \"application/pdf\",\n \"size\": 184233\n }\n ],\n \"createdAt\": \"2026-09-07T10:00:00Z\",\n \"updatedAt\": \"2026-09-07T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payouts", ":paymentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "payouts", ":paymentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payouts", ":paymentId", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentId", "description": "(Required) Payment identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Payment Data Maps", "description": { "content": "Reusable party field mappings and reviewed value translations, stored as immutable definitions for mapped payout requests.", "type": "text/plain" }, "item": [ { "name": "List payment data maps", "request": { "name": "List payment data maps", "description": { "content": "Returns Payment Data Maps stored for your integration. Omit status to include both active and archived maps, or filter by ACTIVE or ARCHIVED.", "type": "text/plain" }, "url": { "path": [ "payment-data-maps" ], "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": "ACTIVE", "description": "Filter maps by status. Omit to include both active and archived maps." } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Payment data map page", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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 \"paymentDataMapId\": \"80cf0b32-e8b3-4468-952d-0313e7c2970f\",\n \"name\": \"string\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"1O0W[].hzNu[].1uBoP\",\n \"target\": \"recipient.name\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"recipient.relationships[].identification.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"VrmNTKYq.zEwT4\",\n \"name\": \"g.IOA3rGd.Eok6sAqRp._4w7EkxwE.kX\",\n \"data\": \"frP7Z3C\"\n },\n \"filters\": [\n {\n \"field\": \"n.h5r.I4n8Z.ZNKKduPmb.HdOZnVmEMH.bhNuuRV5yV.I5xo1Q.0Zw_yT._w5AK1.6jnelqdRH.ee0yvRxcH\",\n \"value\": \"string\"\n },\n {\n \"field\": \"Do7ClY8.9HmH_0nrvL7.sX.q_tFJfe.xB7Vcju0Zco.LV.mIlQ.4mHJxPi\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n },\n {\n \"target\": \"sender.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"iia_Yvv1zpG.FRwvTm\",\n \"name\": \"A3NC.kW0T8J82JI.iZ\",\n \"data\": \"2ls5sWYf.FtS0rt3wx.Dlwqns.Xu5.pk\"\n },\n \"filters\": [\n {\n \"field\": \"E7Ytwr.ewQ2.j.YA8xkEz7U.yUHA.q6cI2h9KozI\",\n \"value\": \"string\"\n },\n {\n \"field\": \"ZgcVzU.5S\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n }\n ],\n \"values\": [\n {\n \"source\": \"Q.Bkvgl0[].sI128tEn[]\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"SALE_OF_OTHER_ASSETS\",\n \"key_1\": \"RENTAL_INCOME\"\n }\n },\n {\n \"source\": \"BdJbXJm3i.u1S2sPK5HI\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"LOAN_PROCEEDS\"\n }\n }\n ],\n \"sender\": \"supplied\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n },\n \"status\": \"ARCHIVED\",\n \"contentHash\": \"sha256:8a4b22d6421e6349c74b6814880d19c9c96a73427bb42d088d057f15c17b37e7\",\n \"createdAt\": \"1997-11-08T08:46:59.828Z\",\n \"description\": \"string\"\n },\n {\n \"paymentDataMapId\": \"8bdbe5dd-834d-87fe-a72b-77e9531e59b4\",\n \"name\": \"string\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"qwb.ziASfhA[].daZZ.T[].Lu.65CFLh[].KtqPTvl[].i[].6.Zg1_.f\",\n \"target\": \"sender.identification.issueDate\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"recipient.identification.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"_xhPMQKbwkf.4PQ3tYU.wXI.tzckFGmPdXa.7jI.bOwKpu.2VdDW5cv2.smQ3t6KMLon.1j8f.k2iuz\",\n \"name\": \"kQmxDn\",\n \"data\": \"RLmjBFXl.jA4c3Bw.o_3bVIivIjA.ML8uW2.vzNwJ.mQJwQySq.lItC.yh_HSa3XcyJ.l4o4UdlJr4A\"\n },\n \"filters\": [\n {\n \"field\": \"Kxh0V9r.u.dOdfwlT.Y5sUuqN5uR3.Bi6L.hFQrJ3_M.4lrwKpMrnY.0cYDxBnnLO.IP.pCSzc3.lGY\",\n \"value\": \"string\"\n },\n {\n \"field\": \"C5X71Yv.ZtOMrvJFUW\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n },\n {\n \"target\": \"supportingDocuments[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"mP4_8k.8coW88.Jd7aG.upA7Bz\",\n \"name\": \"Ptn.F7xK.QwI7Cy.qbx.6BF1ju1Wo.Tx.b.FNi5E.lOC0Fg0t1W\",\n \"data\": \"4HIHK1r.6WsvGipIcng.8Qmbf.FkSWu1Ox.rMg9UNbz.bTQ.djn.d6zfMKCk0\"\n },\n \"filters\": [\n {\n \"field\": \"InpDeld.8b1.lXY4u69hhE.EQ.8uO.cDaenVr_crp.9Xp\",\n \"value\": \"string\"\n },\n {\n \"field\": \"MNI3jI4GZ0i.gtI1VqJuLpZ.Df1EVpkh.j.G6mvlM.D6cVop_KWCV\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n }\n ],\n \"values\": [\n {\n \"source\": \"clDM[].eSIy766Qxh[].e.IvtY[].P96O1epbt5.3_NgjFIGp[].om0ca[]\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"COMMISSION\"\n }\n },\n {\n \"source\": \"pZg[].zD2PP6rW[].W2uhhZYv9AB.g4[]\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"CAPITAL_CONTRIBUTION\",\n \"key_1\": \"INVESTMENT_INCOME\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n },\n \"status\": \"ACTIVE\",\n \"contentHash\": \"sha256:8a4b22d6421e6349c74b6814880d19c9c96a73427bb42d088d057f15c17b37e7\",\n \"createdAt\": \"1949-01-15T09:56:50.661Z\",\n \"description\": \"string\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"endCursor\": \"eyJvZmZzZXQiOjI1fQ==\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" }, { "key": "status", "value": "ACTIVE" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Store a payment data map", "request": { "name": "Store a payment data map", "description": { "content": "Validates and stores rules for mapping a complete payment object: payment and party fields, document connections, reviewed value translations, sender handling, and amount resolution. Download or copy the definition from [Smart Payload Mapping](/payment-api/tools/payload-mapper-v2), then submit it as definition alongside a name. Access is determined by your credentials.\n\nStorage validates the schema version, safe paths, known targets, unique field sources and targets, compatible array associations, document connection rules, and allowed translation outputs. Value rules must match a configured field or document-type connection and must not redefine an existing Axiym code. Invalid or conflicting rules are rejected with HTTP 422. Actual source data, document matches, and corridor requirements are validated when the map is used.\n\nNew maps have status ACTIVE. The response includes paymentDataMapId and contentHash. Definitions are immutable: store changed rules as a new map and use its new identifier.", "type": "text/plain" }, "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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 \"name\": \"Supplier payments\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"instruction.account\",\n \"target\": \"sourceAccountId\"\n },\n {\n \"source\": \"instruction.total\",\n \"target\": \"amount.amount\"\n },\n {\n \"source\": \"instruction.currency\",\n \"target\": \"amount.currency\"\n },\n {\n \"source\": \"instruction.reason\",\n \"target\": \"purpose\"\n },\n {\n \"source\": \"instruction.funding\",\n \"target\": \"sourceOfFunds\"\n },\n {\n \"source\": \"instruction.reference\",\n \"target\": \"reference\"\n },\n {\n \"source\": \"beneficiary.name\",\n \"target\": \"recipient.name\"\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"target\": \"recipient.businessRelationship\"\n },\n {\n \"source\": \"beneficiary.address.line\",\n \"target\": \"recipient.address.streetName\"\n },\n {\n \"source\": \"beneficiary.address.city\",\n \"target\": \"recipient.address.city\"\n },\n {\n \"source\": \"beneficiary.address.country\",\n \"target\": \"recipient.address.country\"\n },\n {\n \"source\": \"beneficiary.account.number\",\n \"target\": \"recipient.destination.accountNumber\"\n },\n {\n \"source\": \"beneficiary.account.currency\",\n \"target\": \"recipient.destination.currency\"\n },\n {\n \"source\": \"beneficiary.account.bank.name\",\n \"target\": \"recipient.destination.bank.bankName\"\n },\n {\n \"source\": \"beneficiary.account.bank.swift\",\n \"target\": \"recipient.destination.bank.swiftBic\"\n },\n {\n \"source\": \"beneficiary.account.bank.country\",\n \"target\": \"recipient.destination.bank.address.country\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"supportingDocuments[]\",\n \"source\": \"files[]\",\n \"association\": \"linked\",\n \"fields\": {\n \"documentType\": \"kind\",\n \"name\": \"fileName\",\n \"data\": \"content\"\n },\n \"matches\": [\n {\n \"fileField\": \"ownerId\",\n \"recordPath\": \"instruction.reference\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"usage\",\n \"value\": \"payment\"\n }\n ]\n }\n ],\n \"values\": [\n {\n \"source\": \"instruction.reason\",\n \"targets\": [\n \"purpose\"\n ],\n \"translations\": {\n \"supplier invoice\": \"GOODS_PURCHASE\"\n }\n },\n {\n \"source\": \"instruction.funding\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"business income\": \"BUSINESS_INCOME\"\n }\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"targets\": [\n \"recipient.businessRelationship\"\n ],\n \"translations\": {\n \"supplier\": \"SUPPLIER\"\n }\n },\n {\n \"source\": \"files[].kind\",\n \"targets\": [\n \"supportingDocuments[].documentType\"\n ],\n \"translations\": {\n \"invoice\": \"INVOICE\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Payment data map stored", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Supplier payments\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"instruction.account\",\n \"target\": \"sourceAccountId\"\n },\n {\n \"source\": \"instruction.total\",\n \"target\": \"amount.amount\"\n },\n {\n \"source\": \"instruction.currency\",\n \"target\": \"amount.currency\"\n },\n {\n \"source\": \"instruction.reason\",\n \"target\": \"purpose\"\n },\n {\n \"source\": \"instruction.funding\",\n \"target\": \"sourceOfFunds\"\n },\n {\n \"source\": \"instruction.reference\",\n \"target\": \"reference\"\n },\n {\n \"source\": \"beneficiary.name\",\n \"target\": \"recipient.name\"\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"target\": \"recipient.businessRelationship\"\n },\n {\n \"source\": \"beneficiary.address.line\",\n \"target\": \"recipient.address.streetName\"\n },\n {\n \"source\": \"beneficiary.address.city\",\n \"target\": \"recipient.address.city\"\n },\n {\n \"source\": \"beneficiary.address.country\",\n \"target\": \"recipient.address.country\"\n },\n {\n \"source\": \"beneficiary.account.number\",\n \"target\": \"recipient.destination.accountNumber\"\n },\n {\n \"source\": \"beneficiary.account.currency\",\n \"target\": \"recipient.destination.currency\"\n },\n {\n \"source\": \"beneficiary.account.bank.name\",\n \"target\": \"recipient.destination.bank.bankName\"\n },\n {\n \"source\": \"beneficiary.account.bank.swift\",\n \"target\": \"recipient.destination.bank.swiftBic\"\n },\n {\n \"source\": \"beneficiary.account.bank.country\",\n \"target\": \"recipient.destination.bank.address.country\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"supportingDocuments[]\",\n \"source\": \"files[]\",\n \"association\": \"linked\",\n \"fields\": {\n \"documentType\": \"kind\",\n \"name\": \"fileName\",\n \"data\": \"content\"\n },\n \"matches\": [\n {\n \"fileField\": \"ownerId\",\n \"recordPath\": \"instruction.reference\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"usage\",\n \"value\": \"payment\"\n }\n ]\n }\n ],\n \"values\": [\n {\n \"source\": \"instruction.reason\",\n \"targets\": [\n \"purpose\"\n ],\n \"translations\": {\n \"supplier invoice\": \"GOODS_PURCHASE\"\n }\n },\n {\n \"source\": \"instruction.funding\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"business income\": \"BUSINESS_INCOME\"\n }\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"targets\": [\n \"recipient.businessRelationship\"\n ],\n \"translations\": {\n \"supplier\": \"SUPPLIER\"\n }\n },\n {\n \"source\": \"files[].kind\",\n \"targets\": [\n \"supportingDocuments[].documentType\"\n ],\n \"translations\": {\n \"invoice\": \"INVOICE\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentDataMapId\": \"3eeadd6c-35a4-f631-4410-80153b193cbc\",\n \"name\": \"string\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"HS.2luFACTLtQ_[].iT8[].YJQ.lfN2c[].cAk2tc[]\",\n \"target\": \"recipient.destination.bank.address.region\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"sender.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"6h032AnKP.ttX07aA.04QR.ABF2.Rs8.dwy80OyW.rmYUv8_.O95.mqvZ.A2yLfrB6BvN\",\n \"name\": \"r31ZxDxfA_z.3b4N8oGkF.Roa4TgRHsKW\",\n \"data\": \"wH8wz_b.ZOLe2egm.8.Pt_w8Mcu.l5vcIW.9yj\"\n },\n \"filters\": [\n {\n \"field\": \"yYKkzC1paWU.Azorqeo.hU1rdOa.Vn25T4OPI.fCqd7Xx.LU_b5SN4WX.JnH.bM6wdNv4x.RxSyhHJ.KzhC.dPEeurK2YN\",\n \"value\": \"string\"\n },\n {\n \"field\": \"gmD.Y.2s.Mx70pUDV.r\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n },\n {\n \"target\": \"recipient.relationships[].identification.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"jNLQSCM5j\",\n \"name\": \"k3itW6Q.qp8gI_f_.hWB9AO.g4gIre.rWyjI.kg0iQ.3bqMnEBe.4cr7yjp8o7C.4ITrDChFCl.2yxOQ\",\n \"data\": \"SaCf.vjSKKw2KST.rtAW9TQa.Y.r1dtDJGs.PZA6c1F5Q23.gUKB2CixJS.BQEEMcWJFx.pzXwXN0mW.J2NvvV2SG.kWkEV1mVIIQ\"\n },\n \"filters\": [\n {\n \"field\": \"8bLBqNuoU\",\n \"value\": \"string\"\n },\n {\n \"field\": \"E3kSB.S0C2vnVCGxt.dfgA228HU.AM.lXjJ.vhIlCpcR.4dR3z.SmQYmbpe.iazMiTzFp\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n }\n ],\n \"values\": [\n {\n \"source\": \"T_QBpK5.FE14J[].B8F._mYlmXQCmuF[].9DRz[].lB1cRHy[].m4dZttp[].NU9gcx74[]\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"LOAN_PROCEEDS\",\n \"key_1\": \"SALE_OF_OTHER_ASSETS\"\n }\n },\n {\n \"source\": \"kK9AtlHr[].I9_ZPVOp.zDI.j6KPLvbD1.5eZgik.ExOS83W4jDo[].Y\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"RENTAL_INCOME\",\n \"key_1\": \"SALE_OF_OTHER_ASSETS\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n },\n \"status\": \"ACTIVE\",\n \"contentHash\": \"sha256:8a4b22d6421e6349c74b6814880d19c9c96a73427bb42d088d057f15c17b37e7\",\n \"createdAt\": \"1998-03-28T00:35:23.067Z\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Supplier payments\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"instruction.account\",\n \"target\": \"sourceAccountId\"\n },\n {\n \"source\": \"instruction.total\",\n \"target\": \"amount.amount\"\n },\n {\n \"source\": \"instruction.currency\",\n \"target\": \"amount.currency\"\n },\n {\n \"source\": \"instruction.reason\",\n \"target\": \"purpose\"\n },\n {\n \"source\": \"instruction.funding\",\n \"target\": \"sourceOfFunds\"\n },\n {\n \"source\": \"instruction.reference\",\n \"target\": \"reference\"\n },\n {\n \"source\": \"beneficiary.name\",\n \"target\": \"recipient.name\"\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"target\": \"recipient.businessRelationship\"\n },\n {\n \"source\": \"beneficiary.address.line\",\n \"target\": \"recipient.address.streetName\"\n },\n {\n \"source\": \"beneficiary.address.city\",\n \"target\": \"recipient.address.city\"\n },\n {\n \"source\": \"beneficiary.address.country\",\n \"target\": \"recipient.address.country\"\n },\n {\n \"source\": \"beneficiary.account.number\",\n \"target\": \"recipient.destination.accountNumber\"\n },\n {\n \"source\": \"beneficiary.account.currency\",\n \"target\": \"recipient.destination.currency\"\n },\n {\n \"source\": \"beneficiary.account.bank.name\",\n \"target\": \"recipient.destination.bank.bankName\"\n },\n {\n \"source\": \"beneficiary.account.bank.swift\",\n \"target\": \"recipient.destination.bank.swiftBic\"\n },\n {\n \"source\": \"beneficiary.account.bank.country\",\n \"target\": \"recipient.destination.bank.address.country\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"supportingDocuments[]\",\n \"source\": \"files[]\",\n \"association\": \"linked\",\n \"fields\": {\n \"documentType\": \"kind\",\n \"name\": \"fileName\",\n \"data\": \"content\"\n },\n \"matches\": [\n {\n \"fileField\": \"ownerId\",\n \"recordPath\": \"instruction.reference\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"usage\",\n \"value\": \"payment\"\n }\n ]\n }\n ],\n \"values\": [\n {\n \"source\": \"instruction.reason\",\n \"targets\": [\n \"purpose\"\n ],\n \"translations\": {\n \"supplier invoice\": \"GOODS_PURCHASE\"\n }\n },\n {\n \"source\": \"instruction.funding\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"business income\": \"BUSINESS_INCOME\"\n }\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"targets\": [\n \"recipient.businessRelationship\"\n ],\n \"translations\": {\n \"supplier\": \"SUPPLIER\"\n }\n },\n {\n \"source\": \"files[].kind\",\n \"targets\": [\n \"supportingDocuments[].documentType\"\n ],\n \"translations\": {\n \"invoice\": \"INVOICE\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Supplier payments\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"instruction.account\",\n \"target\": \"sourceAccountId\"\n },\n {\n \"source\": \"instruction.total\",\n \"target\": \"amount.amount\"\n },\n {\n \"source\": \"instruction.currency\",\n \"target\": \"amount.currency\"\n },\n {\n \"source\": \"instruction.reason\",\n \"target\": \"purpose\"\n },\n {\n \"source\": \"instruction.funding\",\n \"target\": \"sourceOfFunds\"\n },\n {\n \"source\": \"instruction.reference\",\n \"target\": \"reference\"\n },\n {\n \"source\": \"beneficiary.name\",\n \"target\": \"recipient.name\"\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"target\": \"recipient.businessRelationship\"\n },\n {\n \"source\": \"beneficiary.address.line\",\n \"target\": \"recipient.address.streetName\"\n },\n {\n \"source\": \"beneficiary.address.city\",\n \"target\": \"recipient.address.city\"\n },\n {\n \"source\": \"beneficiary.address.country\",\n \"target\": \"recipient.address.country\"\n },\n {\n \"source\": \"beneficiary.account.number\",\n \"target\": \"recipient.destination.accountNumber\"\n },\n {\n \"source\": \"beneficiary.account.currency\",\n \"target\": \"recipient.destination.currency\"\n },\n {\n \"source\": \"beneficiary.account.bank.name\",\n \"target\": \"recipient.destination.bank.bankName\"\n },\n {\n \"source\": \"beneficiary.account.bank.swift\",\n \"target\": \"recipient.destination.bank.swiftBic\"\n },\n {\n \"source\": \"beneficiary.account.bank.country\",\n \"target\": \"recipient.destination.bank.address.country\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"supportingDocuments[]\",\n \"source\": \"files[]\",\n \"association\": \"linked\",\n \"fields\": {\n \"documentType\": \"kind\",\n \"name\": \"fileName\",\n \"data\": \"content\"\n },\n \"matches\": [\n {\n \"fileField\": \"ownerId\",\n \"recordPath\": \"instruction.reference\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"usage\",\n \"value\": \"payment\"\n }\n ]\n }\n ],\n \"values\": [\n {\n \"source\": \"instruction.reason\",\n \"targets\": [\n \"purpose\"\n ],\n \"translations\": {\n \"supplier invoice\": \"GOODS_PURCHASE\"\n }\n },\n {\n \"source\": \"instruction.funding\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"business income\": \"BUSINESS_INCOME\"\n }\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"targets\": [\n \"recipient.businessRelationship\"\n ],\n \"translations\": {\n \"supplier\": \"SUPPLIER\"\n }\n },\n {\n \"source\": \"files[].kind\",\n \"targets\": [\n \"supportingDocuments[].documentType\"\n ],\n \"translations\": {\n \"invoice\": \"INVOICE\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Supplier payments\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"instruction.account\",\n \"target\": \"sourceAccountId\"\n },\n {\n \"source\": \"instruction.total\",\n \"target\": \"amount.amount\"\n },\n {\n \"source\": \"instruction.currency\",\n \"target\": \"amount.currency\"\n },\n {\n \"source\": \"instruction.reason\",\n \"target\": \"purpose\"\n },\n {\n \"source\": \"instruction.funding\",\n \"target\": \"sourceOfFunds\"\n },\n {\n \"source\": \"instruction.reference\",\n \"target\": \"reference\"\n },\n {\n \"source\": \"beneficiary.name\",\n \"target\": \"recipient.name\"\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"target\": \"recipient.businessRelationship\"\n },\n {\n \"source\": \"beneficiary.address.line\",\n \"target\": \"recipient.address.streetName\"\n },\n {\n \"source\": \"beneficiary.address.city\",\n \"target\": \"recipient.address.city\"\n },\n {\n \"source\": \"beneficiary.address.country\",\n \"target\": \"recipient.address.country\"\n },\n {\n \"source\": \"beneficiary.account.number\",\n \"target\": \"recipient.destination.accountNumber\"\n },\n {\n \"source\": \"beneficiary.account.currency\",\n \"target\": \"recipient.destination.currency\"\n },\n {\n \"source\": \"beneficiary.account.bank.name\",\n \"target\": \"recipient.destination.bank.bankName\"\n },\n {\n \"source\": \"beneficiary.account.bank.swift\",\n \"target\": \"recipient.destination.bank.swiftBic\"\n },\n {\n \"source\": \"beneficiary.account.bank.country\",\n \"target\": \"recipient.destination.bank.address.country\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"supportingDocuments[]\",\n \"source\": \"files[]\",\n \"association\": \"linked\",\n \"fields\": {\n \"documentType\": \"kind\",\n \"name\": \"fileName\",\n \"data\": \"content\"\n },\n \"matches\": [\n {\n \"fileField\": \"ownerId\",\n \"recordPath\": \"instruction.reference\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"usage\",\n \"value\": \"payment\"\n }\n ]\n }\n ],\n \"values\": [\n {\n \"source\": \"instruction.reason\",\n \"targets\": [\n \"purpose\"\n ],\n \"translations\": {\n \"supplier invoice\": \"GOODS_PURCHASE\"\n }\n },\n {\n \"source\": \"instruction.funding\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"business income\": \"BUSINESS_INCOME\"\n }\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"targets\": [\n \"recipient.businessRelationship\"\n ],\n \"translations\": {\n \"supplier\": \"SUPPLIER\"\n }\n },\n {\n \"source\": \"files[].kind\",\n \"targets\": [\n \"supportingDocuments[].documentType\"\n ],\n \"translations\": {\n \"invoice\": \"INVOICE\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Supplier payments\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"instruction.account\",\n \"target\": \"sourceAccountId\"\n },\n {\n \"source\": \"instruction.total\",\n \"target\": \"amount.amount\"\n },\n {\n \"source\": \"instruction.currency\",\n \"target\": \"amount.currency\"\n },\n {\n \"source\": \"instruction.reason\",\n \"target\": \"purpose\"\n },\n {\n \"source\": \"instruction.funding\",\n \"target\": \"sourceOfFunds\"\n },\n {\n \"source\": \"instruction.reference\",\n \"target\": \"reference\"\n },\n {\n \"source\": \"beneficiary.name\",\n \"target\": \"recipient.name\"\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"target\": \"recipient.businessRelationship\"\n },\n {\n \"source\": \"beneficiary.address.line\",\n \"target\": \"recipient.address.streetName\"\n },\n {\n \"source\": \"beneficiary.address.city\",\n \"target\": \"recipient.address.city\"\n },\n {\n \"source\": \"beneficiary.address.country\",\n \"target\": \"recipient.address.country\"\n },\n {\n \"source\": \"beneficiary.account.number\",\n \"target\": \"recipient.destination.accountNumber\"\n },\n {\n \"source\": \"beneficiary.account.currency\",\n \"target\": \"recipient.destination.currency\"\n },\n {\n \"source\": \"beneficiary.account.bank.name\",\n \"target\": \"recipient.destination.bank.bankName\"\n },\n {\n \"source\": \"beneficiary.account.bank.swift\",\n \"target\": \"recipient.destination.bank.swiftBic\"\n },\n {\n \"source\": \"beneficiary.account.bank.country\",\n \"target\": \"recipient.destination.bank.address.country\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"supportingDocuments[]\",\n \"source\": \"files[]\",\n \"association\": \"linked\",\n \"fields\": {\n \"documentType\": \"kind\",\n \"name\": \"fileName\",\n \"data\": \"content\"\n },\n \"matches\": [\n {\n \"fileField\": \"ownerId\",\n \"recordPath\": \"instruction.reference\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"usage\",\n \"value\": \"payment\"\n }\n ]\n }\n ],\n \"values\": [\n {\n \"source\": \"instruction.reason\",\n \"targets\": [\n \"purpose\"\n ],\n \"translations\": {\n \"supplier invoice\": \"GOODS_PURCHASE\"\n }\n },\n {\n \"source\": \"instruction.funding\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"business income\": \"BUSINESS_INCOME\"\n }\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"targets\": [\n \"recipient.businessRelationship\"\n ],\n \"translations\": {\n \"supplier\": \"SUPPLIER\"\n }\n },\n {\n \"source\": \"files[].kind\",\n \"targets\": [\n \"supportingDocuments[].documentType\"\n ],\n \"translations\": {\n \"invoice\": \"INVOICE\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payment-data-maps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "key": "Idempotency-Key", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Supplier payments\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"instruction.account\",\n \"target\": \"sourceAccountId\"\n },\n {\n \"source\": \"instruction.total\",\n \"target\": \"amount.amount\"\n },\n {\n \"source\": \"instruction.currency\",\n \"target\": \"amount.currency\"\n },\n {\n \"source\": \"instruction.reason\",\n \"target\": \"purpose\"\n },\n {\n \"source\": \"instruction.funding\",\n \"target\": \"sourceOfFunds\"\n },\n {\n \"source\": \"instruction.reference\",\n \"target\": \"reference\"\n },\n {\n \"source\": \"beneficiary.name\",\n \"target\": \"recipient.name\"\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"target\": \"recipient.businessRelationship\"\n },\n {\n \"source\": \"beneficiary.address.line\",\n \"target\": \"recipient.address.streetName\"\n },\n {\n \"source\": \"beneficiary.address.city\",\n \"target\": \"recipient.address.city\"\n },\n {\n \"source\": \"beneficiary.address.country\",\n \"target\": \"recipient.address.country\"\n },\n {\n \"source\": \"beneficiary.account.number\",\n \"target\": \"recipient.destination.accountNumber\"\n },\n {\n \"source\": \"beneficiary.account.currency\",\n \"target\": \"recipient.destination.currency\"\n },\n {\n \"source\": \"beneficiary.account.bank.name\",\n \"target\": \"recipient.destination.bank.bankName\"\n },\n {\n \"source\": \"beneficiary.account.bank.swift\",\n \"target\": \"recipient.destination.bank.swiftBic\"\n },\n {\n \"source\": \"beneficiary.account.bank.country\",\n \"target\": \"recipient.destination.bank.address.country\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"supportingDocuments[]\",\n \"source\": \"files[]\",\n \"association\": \"linked\",\n \"fields\": {\n \"documentType\": \"kind\",\n \"name\": \"fileName\",\n \"data\": \"content\"\n },\n \"matches\": [\n {\n \"fileField\": \"ownerId\",\n \"recordPath\": \"instruction.reference\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"usage\",\n \"value\": \"payment\"\n }\n ]\n }\n ],\n \"values\": [\n {\n \"source\": \"instruction.reason\",\n \"targets\": [\n \"purpose\"\n ],\n \"translations\": {\n \"supplier invoice\": \"GOODS_PURCHASE\"\n }\n },\n {\n \"source\": \"instruction.funding\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"business income\": \"BUSINESS_INCOME\"\n }\n },\n {\n \"source\": \"beneficiary.relationship\",\n \"targets\": [\n \"recipient.businessRelationship\"\n ],\n \"translations\": {\n \"supplier\": \"SUPPLIER\"\n }\n },\n {\n \"source\": \"files[].kind\",\n \"targets\": [\n \"supportingDocuments[].documentType\"\n ],\n \"translations\": {\n \"invoice\": \"INVOICE\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a payment data map", "request": { "name": "Get a payment data map", "description": { "content": "Returns an active or archived Payment Data Map accessible to your integration, including its status, immutable definition, and content hash.", "type": "text/plain" }, "url": { "path": [ "payment-data-maps", ":paymentDataMapId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Payment data map found", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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 \"paymentDataMapId\": \"3eeadd6c-35a4-f631-4410-80153b193cbc\",\n \"name\": \"string\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"HS.2luFACTLtQ_[].iT8[].YJQ.lfN2c[].cAk2tc[]\",\n \"target\": \"recipient.destination.bank.address.region\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"sender.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"6h032AnKP.ttX07aA.04QR.ABF2.Rs8.dwy80OyW.rmYUv8_.O95.mqvZ.A2yLfrB6BvN\",\n \"name\": \"r31ZxDxfA_z.3b4N8oGkF.Roa4TgRHsKW\",\n \"data\": \"wH8wz_b.ZOLe2egm.8.Pt_w8Mcu.l5vcIW.9yj\"\n },\n \"filters\": [\n {\n \"field\": \"yYKkzC1paWU.Azorqeo.hU1rdOa.Vn25T4OPI.fCqd7Xx.LU_b5SN4WX.JnH.bM6wdNv4x.RxSyhHJ.KzhC.dPEeurK2YN\",\n \"value\": \"string\"\n },\n {\n \"field\": \"gmD.Y.2s.Mx70pUDV.r\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n },\n {\n \"target\": \"recipient.relationships[].identification.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"jNLQSCM5j\",\n \"name\": \"k3itW6Q.qp8gI_f_.hWB9AO.g4gIre.rWyjI.kg0iQ.3bqMnEBe.4cr7yjp8o7C.4ITrDChFCl.2yxOQ\",\n \"data\": \"SaCf.vjSKKw2KST.rtAW9TQa.Y.r1dtDJGs.PZA6c1F5Q23.gUKB2CixJS.BQEEMcWJFx.pzXwXN0mW.J2NvvV2SG.kWkEV1mVIIQ\"\n },\n \"filters\": [\n {\n \"field\": \"8bLBqNuoU\",\n \"value\": \"string\"\n },\n {\n \"field\": \"E3kSB.S0C2vnVCGxt.dfgA228HU.AM.lXjJ.vhIlCpcR.4dR3z.SmQYmbpe.iazMiTzFp\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n }\n ],\n \"values\": [\n {\n \"source\": \"T_QBpK5.FE14J[].B8F._mYlmXQCmuF[].9DRz[].lB1cRHy[].m4dZttp[].NU9gcx74[]\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"LOAN_PROCEEDS\",\n \"key_1\": \"SALE_OF_OTHER_ASSETS\"\n }\n },\n {\n \"source\": \"kK9AtlHr[].I9_ZPVOp.zDI.j6KPLvbD1.5eZgik.ExOS83W4jDo[].Y\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"RENTAL_INCOME\",\n \"key_1\": \"SALE_OF_OTHER_ASSETS\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n },\n \"status\": \"ACTIVE\",\n \"contentHash\": \"sha256:8a4b22d6421e6349c74b6814880d19c9c96a73427bb42d088d057f15c17b37e7\",\n \"createdAt\": \"1998-03-28T00:35:23.067Z\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": [ "payment-data-maps", ":paymentDataMapId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Archive a payment data map", "request": { "name": "Archive a payment data map", "description": { "content": "Archives a Payment Data Map accessible to your integration, preventing its use in new mapped payouts. Returns the map with status ARCHIVED. Repeating the request for an archived map returns the same archived map successfully.\n\nThe map identifier, definition, and content hash are retained for audit and troubleshooting. Archived maps remain retrievable by identifier and appear in unfiltered or ARCHIVED-filtered listings.\n\nPayouts already created with the map retain their prepared instruction and can still be confirmed and processed. Archiving does not cancel or change those payouts.", "type": "text/plain" }, "url": { "path": [ "payment-data-maps", ":paymentDataMapId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Payment data map archived, or already archived.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentDataMapId\": \"3eeadd6c-35a4-f631-4410-80153b193cbc\",\n \"name\": \"string\",\n \"definition\": {\n \"schemaVersion\": \"3\",\n \"fields\": [\n {\n \"source\": \"HS.2luFACTLtQ_[].iT8[].YJQ.lfN2c[].cAk2tc[]\",\n \"target\": \"recipient.destination.bank.address.region\"\n }\n ],\n \"documents\": [\n {\n \"target\": \"sender.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"6h032AnKP.ttX07aA.04QR.ABF2.Rs8.dwy80OyW.rmYUv8_.O95.mqvZ.A2yLfrB6BvN\",\n \"name\": \"r31ZxDxfA_z.3b4N8oGkF.Roa4TgRHsKW\",\n \"data\": \"wH8wz_b.ZOLe2egm.8.Pt_w8Mcu.l5vcIW.9yj\"\n },\n \"filters\": [\n {\n \"field\": \"yYKkzC1paWU.Azorqeo.hU1rdOa.Vn25T4OPI.fCqd7Xx.LU_b5SN4WX.JnH.bM6wdNv4x.RxSyhHJ.KzhC.dPEeurK2YN\",\n \"value\": \"string\"\n },\n {\n \"field\": \"gmD.Y.2s.Mx70pUDV.r\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n },\n {\n \"target\": \"recipient.relationships[].identification.documents[]\",\n \"source\": \"\",\n \"fields\": {\n \"documentType\": \"jNLQSCM5j\",\n \"name\": \"k3itW6Q.qp8gI_f_.hWB9AO.g4gIre.rWyjI.kg0iQ.3bqMnEBe.4cr7yjp8o7C.4ITrDChFCl.2yxOQ\",\n \"data\": \"SaCf.vjSKKw2KST.rtAW9TQa.Y.r1dtDJGs.PZA6c1F5Q23.gUKB2CixJS.BQEEMcWJFx.pzXwXN0mW.J2NvvV2SG.kWkEV1mVIIQ\"\n },\n \"filters\": [\n {\n \"field\": \"8bLBqNuoU\",\n \"value\": \"string\"\n },\n {\n \"field\": \"E3kSB.S0C2vnVCGxt.dfgA228HU.AM.lXjJ.vhIlCpcR.4dR3z.SmQYmbpe.iazMiTzFp\",\n \"value\": \"string\"\n }\n ],\n \"association\": \"nested\"\n }\n ],\n \"values\": [\n {\n \"source\": \"T_QBpK5.FE14J[].B8F._mYlmXQCmuF[].9DRz[].lB1cRHy[].m4dZttp[].NU9gcx74[]\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"LOAN_PROCEEDS\",\n \"key_1\": \"SALE_OF_OTHER_ASSETS\"\n }\n },\n {\n \"source\": \"kK9AtlHr[].I9_ZPVOp.zDI.j6KPLvbD1.5eZgik.ExOS83W4jDo[].Y\",\n \"targets\": [\n \"sourceOfFunds\"\n ],\n \"translations\": {\n \"key_0\": \"RENTAL_INCOME\",\n \"key_1\": \"SALE_OF_OTHER_ASSETS\"\n }\n }\n ],\n \"sender\": \"onboarded-profile\",\n \"amountResolution\": {\n \"method\": \"currency\",\n \"fundingAccount\": \"sourceAccountId\",\n \"recipientCurrency\": \"recipient.destination.currency\",\n \"whenBothMatch\": \"sourceAmount\",\n \"whenNeitherMatches\": \"reject\"\n }\n },\n \"status\": \"ACTIVE\",\n \"contentHash\": \"sha256:8a4b22d6421e6349c74b6814880d19c9c96a73427bb42d088d057f15c17b37e7\",\n \"createdAt\": \"1998-03-28T00:35:23.067Z\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Unexpected server error.", "originalRequest": { "url": { "path": [ "payment-data-maps", ":paymentDataMapId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f407a69a-910a-a060-b376-b195a9612c7a", "key": "paymentDataMapId", "description": "(Required) Immutable payment-data-map identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "disabled": true, "description": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 500,\n \"message\": \"Internal Error\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Webhook Subscriptions", "description": { "content": "Webhook endpoint registration, test deliveries, 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 partnership. Use pagination to retrieve additional subscriptions.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "eyJvZmZzZXQiOjI1fQ==" } ], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 for webhook deliveries. A subscription receives every event available to your partnership; per-event filters are not supported.\n\nStore the returned `subscriptionId` so you can test or disable the subscription later.", "type": "text/plain" }, "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 for the selected subscription. Use it to verify endpoint reachability, signature validation, event persistence, and a successful `2xx` acknowledgement.\n\nA successful API response means Axiym accepted the test request. It does not prove 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": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId", "tests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "disabled": false, "description": "(Required) Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 selected webhook subscription. The endpoint stops receiving new deliveries, and the subscription no longer appears when listing active subscriptions.", "type": "text/plain" }, "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d8979130-4b8f-6797-54c4-285df361921d", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "d8979130-4b8f-6797-54c4-285df361921d", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d8979130-4b8f-6797-54c4-285df361921d", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d8979130-4b8f-6797-54c4-285df361921d", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d8979130-4b8f-6797-54c4-285df361921d", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d8979130-4b8f-6797-54c4-285df361921d", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "d8979130-4b8f-6797-54c4-285df361921d", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d8979130-4b8f-6797-54c4-285df361921d", "key": "subscriptionId", "description": "(Required) Subscription identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 webhook's `X-Key-Id` header. Use the key to verify `X-Signature` against the raw request body.\n\nCache keys by `publicKeyId`. Retrieve the key again when a delivery contains an identifier you do not recognize.", "type": "text/plain" }, "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Webhook signing public key.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"publicKeyId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"algorithm\": \"ED25519\",\n \"publicKey\": \"string\",\n \"createdAt\": \"2026-06-23T14:05:09Z\",\n \"active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Malformed or invalid request.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Missing, expired, or invalid credentials.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "key": "X-Request-Id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\",\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Forbidden", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "Resource not found or not accessible to this integration.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 \"amount\": [\n {\n \"code\": \"length\",\n \"message\": null,\n \"params\": {\n \"value\": \"\",\n \"min\": 1\n }\n }\n ],\n \"recipient\": {\n \"destination\": {\n \"currency\": [\n {\n \"code\": \"invalid_currency\",\n \"message\": null,\n \"params\": {\n \"value\": \"ZZZ\"\n }\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "webhooks", "public-keys", ":publicKeyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "publicKeyId", "description": "(Required) Public key identifier (UUID)." } ] }, "header": [ { "disabled": true, "description": "Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in `X-Request-Id`, or generates one when omitted.", "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": "Request identifier for tracing and support, echoed from the request or generated by Axiym.", "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 Payment API v0.1.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Use the Payment API to make cross-border payments to beneficiaries, whether paying for your organization or on behalf of a client. Each outgoing payment is represented by a payout resource.\n\nCreate a payout with the funding account, amount, and complete payment instruction. Axiym returns the prepared instruction and time-limited commercial terms. Review and confirm the payout before the terms expire to reserve funds and start processing. Your credentials determine which accounts, payouts, Payment Data Maps, and webhook subscriptions your integration can access.\n\nGenerated from /openapi/payment-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." } }