{ "info": { "_postman_id": "801f3926-3291-4721-89c8-ea88ab8cf695", "name": "Iron API - Sandbox Addresses API", "description": "The Stablecoin Payment Network", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "lastUpdatedBy": "35240", "uid": "35240-801f3926-3291-4721-89c8-ea88ab8cf695" }, "item": [ { "name": "addresses", "item": [ { "name": "crypto", "item": [ { "name": "attested", "item": [ { "name": "Register a self-attested wallet address", "id": "f3aa219c-32ec-4426-9dda-59278bd1cd4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/attested", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "attested" ] }, "description": "Register a self-hosted wallet that the customer **declares** they control, without\nproviding a cryptographic signature. Intended for direct customers who cannot sign a\nproof-of-ownership message from their custody UI (e.g. Fireblocks).\n\nLike the signed self-hosted flow, the wallet must be registered before it can be used\nin any flow \u2014 onramp, offramp, or swap \u2014 under the **Travel Rule**. This endpoint is\ncurrently limited to customers in the **US** and **Rest of World** jurisdictions." }, "response": [ { "id": "d0edffad-297d-4501-b854-7e3f74efcc5d", "name": "POST Self-Attested Wallet Succeeded", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/attested", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "attested" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"wallet_address\": \"\",\n \"address_type\": \"Hosted\",\n \"blockchain\": \"Polygon\",\n \"disabled\": \"\",\n \"is_self\": \"\",\n \"name\": \"\",\n \"proof_message\": \"\",\n \"proof_signature\": \"\",\n \"vasp_did\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-d0edffad-297d-4501-b854-7e3f74efcc5d" }, { "id": "057ce22b-c846-4810-b114-48a50bce573a", "name": "POST Self-Attested Wallet Failed (Bad Request)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/attested", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "attested" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-057ce22b-c846-4810-b114-48a50bce573a" }, { "id": "8e72f841-f7a1-47a3-84a3-12767d2c37ca", "name": "POST Self-Attested Wallet Failed (Unauthorized)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/attested", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "attested" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-8e72f841-f7a1-47a3-84a3-12767d2c37ca" }, { "id": "c2ee2b9c-b13d-48ad-8e98-0b30b1a6de4c", "name": "POST Self-Attested Wallet Failed (Forbidden - e.g. region not supported, customer suspended)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/attested", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "attested" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-c2ee2b9c-b13d-48ad-8e98-0b30b1a6de4c" }, { "id": "a883641c-143a-416f-ae07-23890ec014fb", "name": "POST Self-Attested Wallet Failed (Not Found)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/attested", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "attested" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-a883641c-143a-416f-ae07-23890ec014fb" }, { "id": "f15167e8-1d41-42a2-9a45-39c030831585", "name": "POST Self-Attested Wallet Failed (Conflict - Address Already Exists)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/attested", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "attested" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-f15167e8-1d41-42a2-9a45-39c030831585" }, { "id": "07cf5840-55cb-4dfb-ad96-9da3e6de390e", "name": "POST Self-Attested Wallet Failed (Internal Error)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/attested", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "attested" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-07cf5840-55cb-4dfb-ad96-9da3e6de390e" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-f3aa219c-32ec-4426-9dda-59278bd1cd4a" } ], "id": "7ed533be-050f-43cf-b11c-a306f770485d", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-7ed533be-050f-43cf-b11c-a306f770485d" }, { "name": "hosted", "item": [ { "name": "vasps", "item": [ { "name": "Search hosted wallet providers (VASPs)", "id": "8e8c1bd6-34f5-469e-83c4-10e4c4eb2117", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted/vasps?q=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted", "vasps" ], "query": [ { "description": "(Required) query string (min 2 chars)", "key": "q", "value": "" }, { "description": "optional limit (default 20, max 50)", "key": "limit", "value": "" } ] }, "description": "Look up a VASP by name to find its DID (Decentralized Identifier). You need the DID when registering a hosted wallet via [Register Hosted Wallet](#tag/Addresses/operation/registerHostedWallet)." }, "response": [ { "id": "4a3cdb84-3476-401e-ad56-51951138c29d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted/vasps?q=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted", "vasps" ], "query": [ { "description": "(Required) query string (min 2 chars)", "key": "q", "value": "" }, { "description": "optional limit (default 20, max 50)", "key": "limit", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"did\": \"\",\n \"name\": \"\",\n \"country\": \"\",\n \"website\": \"\"\n },\n {\n \"did\": \"\",\n \"name\": \"\",\n \"country\": \"\",\n \"website\": \"\"\n }\n]", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-4a3cdb84-3476-401e-ad56-51951138c29d" }, { "id": "cbeec34c-d0ab-49b2-8d1e-42bebd8258ea", "name": "Bad request (e.g. query too short)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted/vasps?q=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted", "vasps" ], "query": [ { "description": "(Required) query string (min 2 chars)", "key": "q", "value": "" }, { "description": "optional limit (default 20, max 50)", "key": "limit", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-cbeec34c-d0ab-49b2-8d1e-42bebd8258ea" }, { "id": "5c7c0a01-7028-4e6d-ac71-b823e97694f4", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted/vasps?q=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted", "vasps" ], "query": [ { "description": "(Required) query string (min 2 chars)", "key": "q", "value": "" }, { "description": "optional limit (default 20, max 50)", "key": "limit", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5c7c0a01-7028-4e6d-ac71-b823e97694f4" }, { "id": "f03091d6-daaa-45d8-b2cb-d288f38d2368", "name": "VASP search unavailable", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted/vasps?q=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted", "vasps" ], "query": [ { "description": "(Required) query string (min 2 chars)", "key": "q", "value": "" }, { "description": "optional limit (default 20, max 50)", "key": "limit", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-f03091d6-daaa-45d8-b2cb-d288f38d2368" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-8e8c1bd6-34f5-469e-83c4-10e4c4eb2117" } ], "id": "a611f4e3-8099-402f-8a57-fa02ae5056a5", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-a611f4e3-8099-402f-8a57-fa02ae5056a5" }, { "name": "Register a hosted wallet address", "id": "04d04d8d-1727-4746-8016-ac2d05b98018", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"wallet_address\": \"\",\n \"vasp_did\": \"\",\n \"blockchain\": \"Arbitrum\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted" ] }, "description": "Register a wallet that is custodied by another VASP (e.g. Coinbase, Kraken) on behalf of the customer. This is required by the **Travel Rule** before the wallet can be used in **any** flow \u2014 onramp, offramp, or swap.\n\nProvide the VASP's DID (Decentralized Identifier) so Iron can exchange travel-rule data with the custodian. Use the [Search VASPs](#tag/Addresses/operation/searchHostedVasps) endpoint to look up the correct DID.\n" }, "response": [ { "id": "743a6b0f-dfd6-46c5-8943-b4af2f02181d", "name": "Registration successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"wallet_address\": \"\",\n \"vasp_did\": \"\",\n \"blockchain\": \"Arbitrum\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"wallet_address\": \"\",\n \"address_type\": \"Hosted\",\n \"blockchain\": \"Polygon\",\n \"disabled\": \"\",\n \"is_self\": \"\",\n \"name\": \"\",\n \"proof_message\": \"\",\n \"proof_signature\": \"\",\n \"vasp_did\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-743a6b0f-dfd6-46c5-8943-b4af2f02181d" }, { "id": "88035668-d39d-4236-afb7-5446351b72a4", "name": "Bad request (e.g. invalid data)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"wallet_address\": \"\",\n \"vasp_did\": \"\",\n \"blockchain\": \"Arbitrum\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-88035668-d39d-4236-afb7-5446351b72a4" }, { "id": "785d2eef-9ca1-4a59-99f9-f536a75d0df3", "name": "Unauthorized (e.g. customer does not belong to partner)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"wallet_address\": \"\",\n \"vasp_did\": \"\",\n \"blockchain\": \"Arbitrum\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-785d2eef-9ca1-4a59-99f9-f536a75d0df3" }, { "id": "d7b9314c-c3f1-422c-9964-3910f11b2785", "name": "Conflict - Address already exists", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"wallet_address\": \"\",\n \"vasp_did\": \"\",\n \"blockchain\": \"Arbitrum\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-d7b9314c-c3f1-422c-9964-3910f11b2785" }, { "id": "ec258dd0-382c-4c4d-b0f5-b634ab8b4b05", "name": "Failed to register the address", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"wallet_address\": \"\",\n \"vasp_did\": \"\",\n \"blockchain\": \"Arbitrum\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/hosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "hosted" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-ec258dd0-382c-4c4d-b0f5-b634ab8b4b05" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-04d04d8d-1727-4746-8016-ac2d05b98018" } ], "id": "f98126bf-f3a8-49f9-afa0-2bb698a53c15", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-f98126bf-f3a8-49f9-afa0-2bb698a53c15" }, { "name": "selfhosted", "item": [ { "name": "Register a self-hosted wallet address", "id": "4cd3a226-8eb2-4e01-aaf6-057e7150c052", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) a UUID ensuring a signature is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/selfhosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "selfhosted" ] }, "description": "Register a wallet that the customer controls directly (i.e. they hold the private key). This is required by the **Travel Rule** before the wallet can be used in **any** flow \u2014 onramp, offramp, or swap.\n\nSubmit a proof of address ownership. **The message must be in the format**:\n\n> I am verifying ownership of the wallet address [Wallet Address] as customer [CustomerId]. This message was signed on [DD/MM/YYYY] to confirm my control over this wallet.\n\nThe signature must be generated using the private key of the wallet address and is just the standard string format of standard ethereum / solana signatures:\n## Example message\n```ignore\nI am verifying ownership of the wallet address GEhVdAGrGFvbAyj9ieZQt43mRAZZu4hRQ5MaKGgvpJMq as customer 7feaf33d-8551-4144-bfcb-01c86bcff857. This message was signed on 20/01/2024 to confirm my control over this wallet.\n```\n## Example signature\nsolana signature: 3Z3TWYMhq9vrA6K9ajQMQmVi1aXTmyASGLEvMpzNdS3BdWhNKeQGHtvF6cFNzR96tsnPPocJPjxfVsjtay9iWgTG\nevm signature: 0x1234567890abcdef1234567890abcdef12345678900xa5f1751b75a28c12694f02590d29b8cdd68b4f5c783273a75823fc6cfeaa702f1a65fa7c1838ae799fe755c92443cb51631d000922329cdd2ce799eee75f42531babcdef1234567890abcdef\n" }, "response": [ { "id": "97f8e074-1208-4529-8040-3237c886475d", "name": "POST Self-Hosted Wallet Succeeded", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring a signature is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/selfhosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "selfhosted" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"created_at\": \"\",\n \"customer_id\": \"\",\n \"disabled\": \"\",\n \"name\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-97f8e074-1208-4529-8040-3237c886475d" }, { "id": "20e4d20e-5f09-4033-86e2-71c2d38778ec", "name": "POST Self-Hosted Wallet Failed (Bad Request)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring a signature is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/selfhosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "selfhosted" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-20e4d20e-5f09-4033-86e2-71c2d38778ec" }, { "id": "de86414d-e40c-4593-8d56-18c48e63375c", "name": "POST Self-Hosted Wallet Failed (Unauthorized)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring a signature is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/selfhosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "selfhosted" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-de86414d-e40c-4593-8d56-18c48e63375c" }, { "id": "b8f27536-a2a9-4f1c-bc63-db26c110ed0e", "name": "POST Self-Hosted Wallet Failed (Forbidden - e.g. customer is suspended)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring a signature is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/selfhosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "selfhosted" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-b8f27536-a2a9-4f1c-bc63-db26c110ed0e" }, { "id": "4f9bcf0a-38e2-493a-becb-a8e8dee4dc1b", "name": "POST Self-Hosted Wallet Failed (Not Found)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring a signature is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/selfhosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "selfhosted" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-4f9bcf0a-38e2-493a-becb-a8e8dee4dc1b" }, { "id": "e2a34765-14cb-4a0b-b88a-0ea0600e8bb0", "name": "POST Self-Hosted Wallet Failed (Conflict - Address Already Exists)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring a signature is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/selfhosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "selfhosted" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-e2a34765-14cb-4a0b-b88a-0ea0600e8bb0" }, { "id": "41096554-2a33-4907-b42d-34e1c3516b9a", "name": "POST Self-Hosted Wallet Failed (Internal Error)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring a signature is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"blockchain\": \"Solana\",\n \"customer_id\": \"\",\n \"address\": \"\",\n \"signature\": \"\",\n \"message\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/selfhosted", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", "selfhosted" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-41096554-2a33-4907-b42d-34e1c3516b9a" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-4cd3a226-8eb2-4e01-aaf6-057e7150c052" } ], "id": "290d97ea-5a97-471e-9359-9c38887d0e37", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-290d97ea-5a97-471e-9359-9c38887d0e37" }, { "name": "{customer_id}", "item": [ { "name": "Get all registered wallet addresses", "id": "f2b5a769-2154-4c4c-9b80-9fa938dea44c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/:customer_id?filter=All", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":customer_id" ], "query": [ { "description": "Filter for which type of addresses to return", "key": "filter", "value": "All" } ], "variable": [ { "id": "0d4a47b2-e6e2-4f41-aa3e-b5cc690e16fe", "key": "customer_id", "value": "", "description": "(Required) the ID of the customer" } ] }, "description": "Returns every wallet address a customer has registered (linked), including both hosted and self-hosted wallets. Use the `filter` query parameter to narrow by type." }, "response": [ { "id": "3998cde3-2435-439a-8b52-42f8fae77cb1", "name": "GET Wallets Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/:customer_id?filter=All", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":customer_id" ], "query": [ { "description": "Filter for which type of addresses to return", "key": "filter", "value": "All" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"wallet_address\": \"\",\n \"address_type\": \"SelfHosted\",\n \"blockchain\": \"Plasma\",\n \"disabled\": \"\",\n \"is_self\": \"\",\n \"name\": \"\",\n \"proof_message\": \"\",\n \"proof_signature\": \"\",\n \"vasp_did\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"wallet_address\": \"\",\n \"address_type\": \"Hosted\",\n \"blockchain\": \"Moca\",\n \"disabled\": \"\",\n \"is_self\": \"\",\n \"name\": \"\",\n \"proof_message\": \"\",\n \"proof_signature\": \"\",\n \"vasp_did\": \"\"\n }\n]", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-3998cde3-2435-439a-8b52-42f8fae77cb1" }, { "id": "0cf73e9d-bb4f-4ca8-9453-07ba228d645a", "name": "GET Wallets Failed (Bad Request)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/:customer_id?filter=All", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":customer_id" ], "query": [ { "description": "Filter for which type of addresses to return", "key": "filter", "value": "All" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-0cf73e9d-bb4f-4ca8-9453-07ba228d645a" }, { "id": "723462cf-a974-4e89-a07b-b5adab92b3e9", "name": "GET Wallets Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/:customer_id?filter=All", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":customer_id" ], "query": [ { "description": "Filter for which type of addresses to return", "key": "filter", "value": "All" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-723462cf-a974-4e89-a07b-b5adab92b3e9" }, { "id": "0a12101d-aef1-4378-aef0-a7f90106b1b1", "name": "GET Wallets Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/crypto/:customer_id?filter=All", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":customer_id" ], "query": [ { "description": "Filter for which type of addresses to return", "key": "filter", "value": "All" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-0a12101d-aef1-4378-aef0-a7f90106b1b1" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-f2b5a769-2154-4c4c-9b80-9fa938dea44c" } ], "id": "4a70e06b-087f-4f45-a64f-b1d966249593", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-4a70e06b-087f-4f45-a64f-b1d966249593" }, { "name": "{id}", "item": [ { "name": "disabled", "item": [ { "name": "Update the disabled status of a verified crypto address", "id": "3924cb35-69bd-4c55-aae0-566a86796b6b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be updated for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/:id/disabled", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":id", "disabled" ], "variable": [ { "id": "68e6628f-e925-4f4a-9ed4-1df467ad9164", "key": "id", "value": "", "description": "(Required) The ID of the verified crypto address" } ] }, "description": "Enable or disable a verified crypto address. Disabled addresses cannot be used for transactions.\nOnly addresses belonging to the customer of the authenticated partner can be modified.\n" }, "response": [ { "id": "dd18728c-aba1-4e79-bf6b-3aa79c1b52b9", "name": "PUT Disabled Status Succeeded", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be updated for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/:id/disabled", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":id", "disabled" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"wallet_address\": \"\",\n \"address_type\": \"Hosted\",\n \"blockchain\": \"Polygon\",\n \"disabled\": \"\",\n \"is_self\": \"\",\n \"name\": \"\",\n \"proof_message\": \"\",\n \"proof_signature\": \"\",\n \"vasp_did\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-dd18728c-aba1-4e79-bf6b-3aa79c1b52b9" }, { "id": "4e72f03b-8fbf-474c-a6c8-3bc2167523b7", "name": "PUT Disabled Status Failed (Bad Request)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be updated for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/:id/disabled", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":id", "disabled" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-4e72f03b-8fbf-474c-a6c8-3bc2167523b7" }, { "id": "0d2e90a3-bde7-40a1-81c0-0d9de1e9523c", "name": "PUT Disabled Status Failed (Unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be updated for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/:id/disabled", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":id", "disabled" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-0d2e90a3-bde7-40a1-81c0-0d9de1e9523c" }, { "id": "2aec9232-7694-4ded-9d58-cfd36f5d94d6", "name": "PUT Disabled Status Failed (Not Found)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be updated for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/:id/disabled", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":id", "disabled" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-2aec9232-7694-4ded-9d58-cfd36f5d94d6" }, { "id": "8c93d9cd-3cd4-4a36-b088-41ea61ad2b8e", "name": "PUT Disabled Status Failed (Internal Error)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be updated for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/crypto/:id/disabled", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "crypto", ":id", "disabled" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-8c93d9cd-3cd4-4a36-b088-41ea61ad2b8e" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-3924cb35-69bd-4c55-aae0-566a86796b6b" } ], "id": "f489b6a3-be4d-4c84-b47e-6697014bed67", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-f489b6a3-be4d-4c84-b47e-6697014bed67" } ], "id": "255a8aab-1065-4a91-be96-18f2dd76ce4a", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-255a8aab-1065-4a91-be96-18f2dd76ce4a" } ], "id": "e4e87a32-e7f0-41b9-9409-3e5cb74e1571", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-e4e87a32-e7f0-41b9-9409-3e5cb74e1571" }, { "name": "fiat", "item": [ { "name": "{customer_id}", "item": [ { "name": "{fiat_address_id}", "item": [ { "name": "Delete a fiat address", "id": "e08edba6-0e3c-4070-adfd-7bc704e99f24", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat address will be deleted for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "id": "a362b3b7-83d8-4b64-927d-3ceea007859e", "key": "customer_id", "value": "", "description": "(Required) the ID of the customer" }, { "id": "04d9d466-013e-4089-ae7a-b1ffaa7e72a4", "key": "fiat_address_id", "value": "", "description": "(Required) the ID of the fiat address" } ] }, "description": "Soft-delete a fiat address for a customer\n" }, "response": [ { "id": "9baedfb2-590e-4f50-8764-f36bf2c611a8", "name": "Delete Address Succeeded", "originalRequest": { "method": "DELETE", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat address will be deleted for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "fiat_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-9baedfb2-590e-4f50-8764-f36bf2c611a8" }, { "id": "b922fb72-4dcc-45d1-88d3-6eb45d4c331e", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat address will be deleted for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "fiat_address_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-b922fb72-4dcc-45d1-88d3-6eb45d4c331e" }, { "id": "e5cb8bb6-9503-4efc-ba15-a39f710362d8", "name": "Forbidden (e.g. customer is suspended)", "originalRequest": { "method": "DELETE", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat address will be deleted for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "fiat_address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-e5cb8bb6-9503-4efc-ba15-a39f710362d8" }, { "id": "7e4ba272-7af5-4e8e-ab45-a7c3c9402b52", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat address will be deleted for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "fiat_address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-7e4ba272-7af5-4e8e-ab45-a7c3c9402b52" }, { "id": "384d8bce-bae9-4b62-9faa-5f1d462f7889", "name": "Delete Address Failed (Internal Server Error)", "originalRequest": { "method": "DELETE", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat address will be deleted for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "fiat_address_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-384d8bce-bae9-4b62-9faa-5f1d462f7889" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-e08edba6-0e3c-4070-adfd-7bc704e99f24" }, { "name": "Get a specific fiat address", "id": "18992599-af7d-4890-b471-e585792866a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be verified against the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "id": "9a0174f9-b249-4d5c-ab75-e710629ee3ce", "key": "customer_id", "value": "", "description": "(Required) the ID of the customer" }, { "id": "78692ac5-1c62-4a3e-91b7-2c8058cc7e5d", "key": "fiat_address_id", "value": "", "description": "(Required) the ID of the fiat address" } ] }, "description": "Get a specific fiat address by customer ID and address ID\n" }, "response": [ { "id": "5e08ee8f-bb78-4a3f-9f3e-2f3634bc41fb", "name": "GET Address Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be verified against the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "fiat_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"status\": \"Registered\",\n \"currency\": \"\",\n \"bank_account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"country\": \"\",\n \"bank_name\": \"\",\n \"ownership_verified\": \"\",\n \"is_third_party\": \"\",\n \"label\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5e08ee8f-bb78-4a3f-9f3e-2f3634bc41fb" }, { "id": "c4d2f996-a995-49b7-a138-df4f7bc95bf5", "name": "GET Address Failed (Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be verified against the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "fiat_address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-c4d2f996-a995-49b7-a138-df4f7bc95bf5" }, { "id": "1f96fac6-e031-40fe-a793-4115bf902d98", "name": "GET Address Failed (Internal Server Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be verified against the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id/:fiat_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id", ":fiat_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "fiat_address_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-1f96fac6-e031-40fe-a793-4115bf902d98" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-18992599-af7d-4890-b471-e585792866a0" } ], "id": "59825dc3-4a8d-4b41-940e-9935c84a01ae", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-59825dc3-4a8d-4b41-940e-9935c84a01ae" }, { "name": "Get all fiat addresses / bank accounts", "id": "24fd13de-49ec-4011-bd13-0a1fcabef8b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id?cursor=&prev_cursor=&page_size=10&search_term=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the addresses", "key": "search_term", "value": "" } ], "variable": [ { "id": "b92d904a-12eb-48e4-a101-19173c57738a", "key": "customer_id", "value": "", "description": "(Required) the ID of the customer" } ] }, "description": "Get all fiat addresses registered for a customer\n\nBank account structure can vary per country. Therefore, the `bank_account_identifier` is always the identifier\nthat matches how a user would identify it. For SEPA it would be the IBAN.\n\nYou can search by providing a `search_term` parameter. This will search the following fields:\n\n- `bank_account_identifier`\n- `label`\n- `bank_name`" }, "response": [ { "id": "67aeecb5-e1a2-4ad9-bb32-b4597cb4aa7d", "name": "GET Addresses Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id?cursor=&prev_cursor=&page_size=10&search_term=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the addresses", "key": "search_term", "value": "" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"status\": \"AuthorizationRequired\",\n \"currency\": \"\",\n \"bank_account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"country\": \"\",\n \"bank_name\": \"\",\n \"ownership_verified\": \"\",\n \"is_third_party\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"status\": \"RegistrationPending\",\n \"currency\": \"\",\n \"bank_account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"country\": \"\",\n \"bank_name\": \"\",\n \"ownership_verified\": \"\",\n \"is_third_party\": \"\",\n \"label\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"prev_cursor\": null\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-67aeecb5-e1a2-4ad9-bb32-b4597cb4aa7d" }, { "id": "4ecadef6-3192-402d-8322-279581139890", "name": "GET Addresses Failed (Bad Request)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id?cursor=&prev_cursor=&page_size=10&search_term=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the addresses", "key": "search_term", "value": "" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-4ecadef6-3192-402d-8322-279581139890" }, { "id": "68e39bbf-ad9a-426d-886a-c443163a2ba3", "name": "GET Addresses Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id?cursor=&prev_cursor=&page_size=10&search_term=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the addresses", "key": "search_term", "value": "" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-68e39bbf-ad9a-426d-886a-c443163a2ba3" }, { "id": "322e5ec5-cc0f-4b12-8941-486d7586d865", "name": "GET Addresses Failed (Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id?cursor=&prev_cursor=&page_size=10&search_term=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the addresses", "key": "search_term", "value": "" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-322e5ec5-cc0f-4b12-8941-486d7586d865" }, { "id": "6ab5e5d1-d5b2-40e5-8495-630121a8bfa2", "name": "GET Addresses Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:customer_id?cursor=&prev_cursor=&page_size=10&search_term=", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":customer_id" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the addresses", "key": "search_term", "value": "" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-6ab5e5d1-d5b2-40e5-8495-630121a8bfa2" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-24fd13de-49ec-4011-bd13-0a1fcabef8b3" } ], "id": "7822874e-980b-42e7-b229-8746d45fb091", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-7822874e-980b-42e7-b229-8746d45fb091" }, { "name": "{id}", "item": [ { "name": "retry-auth", "item": [ { "name": "Retry Authentication", "id": "73f0c32e-ea8d-412b-a90c-848276bc7a2a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:id/retry-auth", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":id", "retry-auth" ], "variable": [ { "id": "6dfbd0e7-98bb-455d-a892-9434a8e69ce0", "key": "id", "value": "", "description": "(Required) the ID of the fiat address" } ] }, "description": "Retry the authentication process on a failed fiat address\n\nNOTE: This endpoint is not yet implemented\n" }, "response": [ { "id": "43016e90-b4a2-4222-b10d-97ff010f7727", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:id/retry-auth", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":id", "retry-auth" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-43016e90-b4a2-4222-b10d-97ff010f7727" }, { "id": "346d7185-7739-41ce-9930-48631f18d5b2", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat/:id/retry-auth", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat", ":id", "retry-auth" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-346d7185-7739-41ce-9930-48631f18d5b2" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-73f0c32e-ea8d-412b-a90c-848276bc7a2a" } ], "id": "4d689577-af5c-4c96-b912-650ce5bb0f89", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-4d689577-af5c-4c96-b912-650ce5bb0f89" } ], "id": "1a1b9b24-92dd-4dde-a167-137ce153fd00", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-1a1b9b24-92dd-4dde-a167-137ce153fd00" }, { "name": "Get all fiat addresses with status", "id": "b26bc21e-ea61-46fb-9f8c-3245f26643bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat?status=&cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ], "query": [ { "description": "The Status to filter by. If not provided, defaults to `Registered`", "key": "status", "value": "" }, { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ] }, "description": "Get all fiat addresses with a specific status for the current partner\n" }, "response": [ { "id": "1af3f049-e444-4b0a-b499-d43b2bbbb30e", "name": "GET Addresses Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat?status=&cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ], "query": [ { "description": "The Status to filter by. If not provided, defaults to `Registered`", "key": "status", "value": "" }, { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"status\": \"AuthorizationRequired\",\n \"currency\": \"\",\n \"bank_account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"country\": \"\",\n \"bank_name\": \"\",\n \"ownership_verified\": \"\",\n \"is_third_party\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"status\": \"RegistrationPending\",\n \"currency\": \"\",\n \"bank_account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"country\": \"\",\n \"bank_name\": \"\",\n \"ownership_verified\": \"\",\n \"is_third_party\": \"\",\n \"label\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"prev_cursor\": null\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-1af3f049-e444-4b0a-b499-d43b2bbbb30e" }, { "id": "b615b1fe-96a1-48f8-8558-76107c5ff317", "name": "GET Addresses Failed (Bad Request)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat?status=&cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ], "query": [ { "description": "The Status to filter by. If not provided, defaults to `Registered`", "key": "status", "value": "" }, { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-b615b1fe-96a1-48f8-8558-76107c5ff317" }, { "id": "1e7488f6-ae46-4c54-b790-5a4dc3000e13", "name": "GET Addresses Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat?status=&cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ], "query": [ { "description": "The Status to filter by. If not provided, defaults to `Registered`", "key": "status", "value": "" }, { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-1e7488f6-ae46-4c54-b790-5a4dc3000e13" }, { "id": "74f4724f-cf4e-4dc2-8c8b-608a66ded5bd", "name": "GET Addresses Failed (Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat?status=&cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ], "query": [ { "description": "The Status to filter by. If not provided, defaults to `Registered`", "key": "status", "value": "" }, { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-74f4724f-cf4e-4dc2-8c8b-608a66ded5bd" }, { "id": "fc8019d0-1ad3-46b9-b294-a94d17d8ccc5", "name": "GET Addresses Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the fiat addresses will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/fiat?status=&cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ], "query": [ { "description": "The Status to filter by. If not provided, defaults to `Registered`", "key": "status", "value": "" }, { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-fc8019d0-1ad3-46b9-b294-a94d17d8ccc5" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-b26bc21e-ea61-46fb-9f8c-3245f26643bb" }, { "name": "Register a fiat bank account for a customer.", "id": "59a7667f-0407-4cdc-87de-8ef1cf93d4dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] }, "description": "Register a bank account address for a customer.\n" }, "response": [ { "id": "5623767c-d940-443b-9e9b-60ca85dfc8a0", "name": "Registration successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"status\": \"Registered\",\n \"currency\": \"\",\n \"bank_account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"country\": \"\",\n \"bank_name\": \"\",\n \"ownership_verified\": \"\",\n \"is_third_party\": \"\",\n \"label\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5623767c-d940-443b-9e9b-60ca85dfc8a0" }, { "id": "c3afc5bf-137e-416c-bc1b-57b9f7bcc69e", "name": "Bad request (e.g. invalid data)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-c3afc5bf-137e-416c-bc1b-57b9f7bcc69e" }, { "id": "d830d660-6680-4402-9ef9-4634f6235a7a", "name": "Unauthorized (e.g. customer does not belong to partner)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-d830d660-6680-4402-9ef9-4634f6235a7a" }, { "id": "5e097551-c5f6-4213-bbfe-9610f830d557", "name": "Forbidden (e.g. customer is suspended)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5e097551-c5f6-4213-bbfe-9610f830d557" }, { "id": "fc80b278-e3e7-44d2-a53c-0fb47155691c", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-fc80b278-e3e7-44d2-a53c-0fb47155691c" }, { "id": "5385ec4a-1e03-4a6d-ad3f-d421bf4ebb1b", "name": "Conflict (e.g. address already exists for this customer)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5385ec4a-1e03-4a6d-ad3f-d421bf4ebb1b" }, { "id": "f1546971-4132-47dd-baf3-ef60d98aaeba", "name": "Unprocessable Entity (e.g. customer does not have access to this rail)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-f1546971-4132-47dd-baf3-ef60d98aaeba" }, { "id": "de18f56d-ff05-40b8-9176-5717a1e34d6b", "name": "Failed to register the address", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the fiat address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"bank_details\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"provider_name\": \"\",\n \"provider_country\": {\n \"code\": \"\"\n },\n \"account_identifier\": {\n \"iban\": \"\",\n \"type\": \"SEPA\"\n },\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"is_third_party\": \"\",\n \"bank_address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": {\n \"code\": \"\"\n },\n \"postal_code\": \"\"\n },\n \"email_address\": {\n \"email\": \"\"\n },\n \"phone_number\": \"\"\n },\n \"currency\": {\n \"code\": \"\"\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/fiat", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "fiat" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-de18f56d-ff05-40b8-9176-5717a1e34d6b" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-59a7667f-0407-4cdc-87de-8ef1cf93d4dc" } ], "id": "9c1d9e7d-4a97-4ddd-8796-7717d2daa780", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-9c1d9e7d-4a97-4ddd-8796-7717d2daa780" }, { "name": "pix", "item": [ { "name": "{customer_id}", "item": [ { "name": "{pix_address_id}", "item": [ { "name": "Delete a PIX destination.", "id": "2858bc93-bc91-4d83-a75c-7ab489708857", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "id": "24249d3f-25ca-4db3-9382-5d965b9fd8b1", "key": "customer_id", "value": "", "description": "(Required) the ID of the customer" }, { "id": "72ae99e4-1e53-4361-9012-54504f15a042", "key": "pix_address_id", "value": "", "description": "(Required) the ID of the PIX address" } ] }, "description": "Soft-deletes a PIX destination for a customer." }, "response": [ { "id": "8f3db5c7-edf7-4dc2-ad88-e10abda96032", "name": "Delete Address Succeeded", "originalRequest": { "method": "DELETE", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "pix_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-8f3db5c7-edf7-4dc2-ad88-e10abda96032" }, { "id": "53830dbf-dd55-401f-8f2c-e3618bda4bc1", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "pix_address_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-53830dbf-dd55-401f-8f2c-e3618bda4bc1" }, { "id": "5caecac9-bc91-4799-8dce-40cd2b76b6ec", "name": "Forbidden (e.g. customer is suspended)", "originalRequest": { "method": "DELETE", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "pix_address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5caecac9-bc91-4799-8dce-40cd2b76b6ec" }, { "id": "cfae0f14-00c5-436a-a276-829c92f2fbcd", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "pix_address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-cfae0f14-00c5-436a-a276-829c92f2fbcd" }, { "id": "b0fb1960-b044-46da-be8b-b5a6d3256c85", "name": "Delete Address Failed (Internal Server Error)", "originalRequest": { "method": "DELETE", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "pix_address_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-b0fb1960-b044-46da-be8b-b5a6d3256c85" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-2858bc93-bc91-4d83-a75c-7ab489708857" }, { "name": "Get a specific PIX destination by ID.", "id": "40e308ce-14bb-4c85-94b9-8e40f66458d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "id": "c75ea133-b482-4243-87d6-dd00b04dd246", "key": "customer_id", "value": "", "description": "(Required) the ID of the customer" }, { "id": "c7a06fea-03b7-406c-b995-bc2a8ffdb496", "key": "pix_address_id", "value": "", "description": "(Required) the ID of the PIX address" } ] } }, "response": [ { "id": "b5172546-5651-4a87-bad2-45978a09b07d", "name": "GET Address Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "pix_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"55.343.188/4802-24\",\n \"account\": {\n \"key\": \"629.502.074-26\",\n \"type\": \"CPF\"\n }\n },\n \"status\": \"Registered\",\n \"label\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-b5172546-5651-4a87-bad2-45978a09b07d" }, { "id": "5385a80f-6b9a-42e5-ae4b-adc8f9f37b8f", "name": "GET Address Failed (Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "pix_address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5385a80f-6b9a-42e5-ae4b-adc8f9f37b8f" }, { "id": "98cee601-5536-4043-a5c4-9bea8d670508", "name": "GET Address Failed (Internal Server Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id/:pix_address_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id", ":pix_address_id" ], "variable": [ { "key": "customer_id" }, { "key": "pix_address_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-98cee601-5536-4043-a5c4-9bea8d670508" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-40e308ce-14bb-4c85-94b9-8e40f66458d2" } ], "id": "a6df74b1-fb34-4e6b-89a1-1294ad8f088c", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-a6df74b1-fb34-4e6b-89a1-1294ad8f088c" }, { "name": "Get a customer's PIX destinations.", "id": "3d843841-3385-4c9c-b046-f06baa57a4de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id" ], "variable": [ { "id": "787b6432-93c1-4dd9-9006-2e6c8241a869", "key": "customer_id", "value": "", "description": "(Required) the ID of the customer" } ] } }, "response": [ { "id": "04a5535c-5358-4f34-bb94-29af173926fc", "name": "GET Addresses Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id" ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"39.291.353/1024-67\",\n \"account\": {\n \"key\": \"265.654.028-33\",\n \"type\": \"CPF\"\n }\n },\n \"status\": \"RegistrationPending\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"58131563880547\",\n \"account\": {\n \"key\": \"399.090.032-15\",\n \"type\": \"CPF\"\n }\n },\n \"status\": \"RegistrationFailed\",\n \"label\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"prev_cursor\": null\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-04a5535c-5358-4f34-bb94-29af173926fc" }, { "id": "4903eab3-9689-4a5e-ab9d-9375268e54d3", "name": "GET Addresses Failed (Bad Request)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id" ], "variable": [ { "key": "customer_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-4903eab3-9689-4a5e-ab9d-9375268e54d3" }, { "id": "401c35a2-e69e-4878-99b5-e3ea53a04684", "name": "GET Addresses Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id" ], "variable": [ { "key": "customer_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-401c35a2-e69e-4878-99b5-e3ea53a04684" }, { "id": "3c3ddc1d-d983-49f8-8ce8-d0eb397a5bc4", "name": "GET Addresses Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/pix/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix", ":customer_id" ], "variable": [ { "key": "customer_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-3c3ddc1d-d983-49f8-8ce8-d0eb397a5bc4" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-3d843841-3385-4c9c-b046-f06baa57a4de" } ], "id": "da71be9e-4d7c-4392-9a1e-03eeff969956", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-da71be9e-4d7c-4392-9a1e-03eeff969956" }, { "name": "Register a PIX destination for a customer.", "id": "1e2a1ea4-dc69-445b-bb1a-dd00ae72466d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"26473732638498\",\n \"account\": {\n \"key\": \"624.021.264-20\",\n \"type\": \"CPF\"\n }\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/pix", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix" ] }, "description": "Registers a PIX payout destination (Brazil / BRL). Check the returned\n`status` to determine whether the destination can be used for payouts." }, "response": [ { "id": "5aaeaeb7-fcaa-444a-af53-8122b46ca666", "name": "Registration successful", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"26473732638498\",\n \"account\": {\n \"key\": \"624.021.264-20\",\n \"type\": \"CPF\"\n }\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/pix", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"55.343.188/4802-24\",\n \"account\": {\n \"key\": \"629.502.074-26\",\n \"type\": \"CPF\"\n }\n },\n \"status\": \"Registered\",\n \"label\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5aaeaeb7-fcaa-444a-af53-8122b46ca666" }, { "id": "199bec86-9885-4169-979a-25c4381a2c88", "name": "Bad request (e.g. invalid data)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"26473732638498\",\n \"account\": {\n \"key\": \"624.021.264-20\",\n \"type\": \"CPF\"\n }\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/pix", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-199bec86-9885-4169-979a-25c4381a2c88" }, { "id": "379fff59-fab5-40ae-9330-687876601051", "name": "Unauthorized (e.g. customer does not belong to partner)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"26473732638498\",\n \"account\": {\n \"key\": \"624.021.264-20\",\n \"type\": \"CPF\"\n }\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/pix", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-379fff59-fab5-40ae-9330-687876601051" }, { "id": "c75843d6-618e-48d9-9a4b-1c444140a7ce", "name": "Forbidden (e.g. customer is suspended)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"26473732638498\",\n \"account\": {\n \"key\": \"624.021.264-20\",\n \"type\": \"CPF\"\n }\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/pix", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-c75843d6-618e-48d9-9a4b-1c444140a7ce" }, { "id": "24ac5e66-0edf-46f4-b5b6-15aeb886f624", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"26473732638498\",\n \"account\": {\n \"key\": \"624.021.264-20\",\n \"type\": \"CPF\"\n }\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/pix", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-24ac5e66-0edf-46f4-b5b6-15aeb886f624" }, { "id": "c8110c38-fce0-4e82-b667-baa619a78d0f", "name": "Conflict (e.g. address already exists for this customer)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"26473732638498\",\n \"account\": {\n \"key\": \"624.021.264-20\",\n \"type\": \"CPF\"\n }\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/pix", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-c8110c38-fce0-4e82-b667-baa619a78d0f" }, { "id": "918f9e8b-1b67-4329-a59d-96a7258bf551", "name": "Failed to register the address", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an address is only registered once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"recipient\": {\n \"recipient\": {\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"type\": \"Individual\"\n },\n \"tax_id\": \"26473732638498\",\n \"account\": {\n \"key\": \"624.021.264-20\",\n \"type\": \"CPF\"\n }\n },\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/pix", "host": [ "{{baseUrl}}" ], "path": [ "addresses", "pix" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-918f9e8b-1b67-4329-a59d-96a7258bf551" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-1e2a1ea4-dc69-445b-bb1a-dd00ae72466d" } ], "id": "9e310f7e-121e-42d7-88f2-b5f0e8a52d50", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-9e310f7e-121e-42d7-88f2-b5f0e8a52d50" } ], "id": "5b0709e0-5a3d-4adf-b835-b8d0b872d110", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-5b0709e0-5a3d-4adf-b835-b8d0b872d110" }, { "name": "country_subdivisions", "item": [ { "name": "{country_code}", "item": [ { "name": "Get country subdivisions", "id": "07980eca-e47c-41a3-bc47-972c9cb7248a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/country_subdivisions/:country_code", "host": [ "{{baseUrl}}" ], "path": [ "country_subdivisions", ":country_code" ], "variable": [ { "id": "f18734ae-1432-41ee-ae0c-e54e4ba13e22", "key": "country_code", "value": "", "description": "(Required) The ISO 3166-1 Alpha-2 country code" } ] }, "description": "Utility endpoint to get a list of all accepted subdivisions (states, provinces, regions, etc.) for a given country\n" }, "response": [ { "id": "6d7b8b8d-fda4-4d73-a5e3-d8c5c41d9c36", "name": "GET Subdivisions Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/country_subdivisions/:country_code", "host": [ "{{baseUrl}}" ], "path": [ "country_subdivisions", ":country_code" ], "variable": [ { "key": "country_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\"\n }\n]", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-6d7b8b8d-fda4-4d73-a5e3-d8c5c41d9c36" }, { "id": "3db10d51-ef27-4be1-b1e5-625324a58969", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/country_subdivisions/:country_code", "host": [ "{{baseUrl}}" ], "path": [ "country_subdivisions", ":country_code" ], "variable": [ { "key": "country_code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-3db10d51-ef27-4be1-b1e5-625324a58969" }, { "id": "d76212a6-8af3-4ecf-b9a0-545fee28e3e7", "name": "Country not found or has no subdivisions", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/country_subdivisions/:country_code", "host": [ "{{baseUrl}}" ], "path": [ "country_subdivisions", ":country_code" ], "variable": [ { "key": "country_code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-d76212a6-8af3-4ecf-b9a0-545fee28e3e7" } ], "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-07980eca-e47c-41a3-bc47-972c9cb7248a" } ], "id": "446f80dd-0299-4af3-a7ae-ec744e487504", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-446f80dd-0299-4af3-a7ae-ec744e487504" } ], "id": "aba4962e-5599-4ff4-bd92-90c0d41b2467", "createdAt": "2026-07-28T03:23:43.000Z", "updatedAt": "2026-07-28T03:23:43.000Z", "uid": "35240-aba4962e-5599-4ff4-bd92-90c0d41b2467" } ], "variable": [ { "key": "baseUrl", "value": "https://api.sandbox.iron.xyz/api" } ] }