{ "openapi": "3.1.0", "info": { "title": "rest-v3", "version": "1.0" }, "servers": [ { "url": "https://trade-uk.sandbox.zodiamarkets.com" } ], "components": { "securitySchemes": { "restKey": { "type": "apiKey", "in": "header", "name": "Rest-Key", "description": "Your API key." }, "restSign": { "type": "apiKey", "in": "header", "name": "Rest-Sign", "description": "Base64 HMAC-SHA512 of the request, signed with your API secret. See Authentication." } } }, "security": [ { "restKey": [], "restSign": [] } ], "tags": [ { "name": "Authentication", "description": "Obtain the signed token this API requires before you can call any other endpoint." }, { "name": "Accounts", "description": "Check balances, credit limits, and transaction or transfer history, and move funds between your own accounts." }, { "name": "Payment participants", "description": "Look up the beneficiaries, senders, and your own onboarded entity, together with the wallets and bank accounts verified for each, used to settle trades with third parties." }, { "name": "Trading", "description": "See which instruments are available to trade and review the trades you have executed." }, { "name": "Withdrawals", "description": "Request a withdrawal of fiat or crypto to a destination you have already registered, track it, and cancel it while it is still awaiting approval." } ], "paths": { "/api/3/user/limit": { "post": { "tags": [ "Accounts" ], "summary": "Get Trading Limit", "description": "Get the trading limit for your account.", "operationId": "get-trading-limit", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000 }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Response with Limits": { "value": "{\n \"limit\": {\n \"limitAmount\": 1000.00,\n \"exposureAmount\": 1000.00,\n \"isNetSettlementMode\": true,\n \"limitCurrency\": \"USD\",\n \"exposureCurrency\": \"USD\",\n \"limitUtilisationPercentage\": 100.00\n },\n \"timestamp\": \"1656987491835\",\n \"resultCode\": \"OK\"\n}" }, "Response Without Limitis": { "value": "{\n \"limit\": {},\n \"timestamp\": \"1656987491835\",\n \"resultCode\": \"OK\"\n}" } }, "schema": { "oneOf": [ { "title": "Response with Limits", "type": "object", "properties": { "limit": { "type": "object", "properties": { "limitAmount": { "type": "integer", "example": 1000, "default": "2000000", "description": "Current Limit amount assigned" }, "exposureAmount": { "type": "integer", "example": 1000, "default": 0, "description": "Current Exposure (used amount)" }, "isNetSettlementMode": { "type": "boolean", "example": true, "default": true, "description": "Is the remaining limit calculated on net or gross settlement bases" }, "limitCurrency": { "type": "string", "example": "USD", "description": "Default USD", "default": "USD" }, "exposureCurrency": { "type": "string", "example": "USD", "description": "Default USD", "default": "USD" }, "limitUtilisationPercentage": { "type": "integer", "example": 100, "default": 0, "description": "Utilization of current limit in percentage terms" } }, "description": "Limit block" }, "timestamp": { "type": "string", "example": "1656987491835" }, "resultCode": { "type": "string", "example": "OK" } } }, { "title": "Response Without Limitis", "type": "object", "properties": { "limit": { "type": "object", "properties": {} }, "timestamp": { "type": "string", "example": "1656987491835" }, "resultCode": { "type": "string", "example": "OK" } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"INVALID_NONCE_OR_TONCE\",\n \"timestamp\":\"1666520496583\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "INVALID_NONCE_OR_TONCE" }, "timestamp": { "type": "string", "example": "1666520496583" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"timestamp\": \"1666418418989\",\n \"resultCode\": \"UNAUTHORISED\"\n}" } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "1666418418989" }, "resultCode": { "type": "string", "example": "UNAUTHORISED" } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"timestamp\": \"1666418418989\",\n \"resultCode\": \"UNAUTHORISED\"\n}" } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "1666418418989" }, "resultCode": { "type": "string", "example": "UNAUTHORISED" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"apiVersion\":\"1.0.0\",\n \"error\":\"SYSTEM_ERROR\",\n \"timestamp\":1666587269\n}" } }, "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "example": "1.0.0" }, "error": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "integer", "example": 1666587269, "default": 0 } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"SYSTEM_ERROR\",\n \"timestamp\":\"1666580244296\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "string", "example": "1666580244296" } } } } } } }, "deprecated": false } }, "/zm/rest/available-instruments": { "get": { "tags": [ "Trading" ], "summary": "Get Available Instruments", "description": "Get the available trading instruments for streaming", "operationId": "get-available-instruments", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Response with instruments": { "value": { "instruments": [ { "instrument": "USDC.AED", "enabled": true, "active": true }, { "instrument": "USDC.AUD", "enabled": true, "active": false }, { "instrument": "USDC.BHD", "enabled": false, "active": false } ] } } }, "schema": { "type": "object", "required": [ "instruments" ], "properties": { "instruments": { "type": "array", "description": "Every instrument configured for RFS trading, sorted by `instrument`. Presence in this list does not mean the pair can be dealt right now — read `enabled` and `active`.", "items": { "type": "object", "required": [ "instrument", "settleDate", "levels", "enabled", "active" ], "properties": { "instrument": { "type": "string", "description": "The pair, written `BASE.QUOTE` in upper case — `USDC.AED`. This is the exact string to send as `instrument` when subscribing on the WebSocket; it is matched literally, so do not reformat it." }, "settleDate": { "type": "string", "description": "Reserved for future use. Always an empty string." }, "levels": { "type": "array", "description": "Reserved for future use. Always empty.", "items": { "type": "object", "properties": { "level": { "type": "number", "description": "Reserved for future use." }, "available": { "type": "boolean", "description": "Reserved for future use." } } } }, "enabled": { "type": "boolean", "description": "Whether the pair is open for trading. `false` means Zodia Markets has suspended it — subscribing will not produce prices until it is re-enabled." }, "active": { "type": "boolean", "description": "Whether prices are flowing for the pair at this moment. `false` on an `enabled` pair is normal outside its market hours; subscribe and prices will arrive when the market opens." } } } } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"SYSTEM_ERROR\",\n \"timestamp\":\"1666580244296\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "string", "example": "1666580244296" } } } } } } }, "deprecated": false, "security": [] } }, "/api/3/zm/rest/auth/token": { "post": { "tags": [ "Authentication" ], "summary": "Request Authentication Token", "description": "WebSocket connection token can be generated using this REST endpoint as shown below.", "operationId": "request-authentication-token", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API Key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000 }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "SUCCESS": { "value": "{\n \"token\":\"34g34ehr-45j5-bg6j-alo2-37a926ced90b\",\n \"message\":\"\"\n}" }, "Failed": { "value": "{\n \"token\":\"\",\n \"message\":\"Authentication request has failed!\"\n}" } }, "schema": { "oneOf": [ { "title": "SUCCESS", "type": "object", "properties": { "token": { "type": "string", "example": "34g34ehr-45j5-bg6j-alo2-37a926ced90b" }, "message": { "type": "string", "example": "" } } }, { "title": "Failed", "type": "object", "properties": { "token": { "type": "string", "example": "" }, "message": { "type": "string", "example": "Authentication request has failed!" } } } ] } } } } }, "deprecated": false } }, "/api/3/transfer/list": { "post": { "tags": [ "Accounts" ], "summary": "Get Transfer List", "description": "Get the list of all fund movements (deposits, withdrawals and movements between accounts).", "operationId": "get-transfers", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "ccy": "BTC", "from": 1664582400000, "to": 1667260800000 }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "ccy": { "type": "string", "description": "Currency ticker (e.g. BTC, USD). Omit to return transfers in every currency." }, "from": { "type": "integer", "description": "Start time (inclusive) of transfers, format in Unix time in **milliseconds** — note that `tonce` above is in microseconds. Omitting it does not mean \"from the beginning\": it defaults to 7 days ago, so a query with no `from` silently returns only the last week.", "format": "int64" }, "to": { "type": "integer", "description": "End time (inclusive) of transfers, format in Unix time in **milliseconds**. Defaults to now.", "format": "int64" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"count\":1,\n \"resultCode\":\"OK\",\n \"timestamp\":\"1666527500251\",\n \"totalCount\":1,\n \"transfers\":[\n {\n \"amount\":\"0.32890000\",\n \"ccy\":\"BTC\",\n \"fromType\":\"BROKERAGE\",\n \"lastUpdated\":\"2022-10-23 20:17:49\",\n \"state\":\"PROCESSING\",\n \"toType\":\"AVAILABLE\",\n \"uuid\":\"0c8c68ea-c804-4424-8145-c75ca26f58a7\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "count": { "type": "integer", "example": 1, "default": 0 }, "resultCode": { "type": "string", "example": "OK" }, "timestamp": { "type": "string", "example": "1666527500251" }, "totalCount": { "type": "integer", "example": 1, "default": 0 }, "transfers": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "string", "example": "0.32890000" }, "ccy": { "type": "string", "example": "BTC" }, "fromType": { "type": "string", "example": "BROKERAGE" }, "lastUpdated": { "type": "string", "example": "2022-10-23 20:17:49" }, "state": { "type": "string", "example": "PROCESSING" }, "toType": { "type": "string", "example": "AVAILABLE" }, "uuid": { "type": "string", "example": "0c8c68ea-c804-4424-8145-c75ca26f58a7" } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"INVALID_PARAMETERS\",\n \"timestamp\":\"1666521119313\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "INVALID_PARAMETERS" }, "timestamp": { "type": "string", "example": "1666521119313" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"UNAUTHORISED\",\n \"timestamp\":\"1666527811848\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "UNAUTHORISED" }, "timestamp": { "type": "string", "example": "1666527811848" } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"UNAUTHORISED\",\n \"timestamp\":\"1666521142498\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "UNAUTHORISED" }, "timestamp": { "type": "string", "example": "1666521142498" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"apiVersion\":\"1.0.0\",\n \"error\":\"SYSTEM_ERROR\",\n \"timestamp\":1666521179\n}" } }, "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "example": "1.0.0" }, "error": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "integer", "example": 1666521179, "default": 0 } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"SYSTEM_ERROR\",\n \"timestamp\":\"1666580244296\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "string", "example": "1666580244296" } } } } } } }, "deprecated": false } }, "/api/3/transfer": { "post": { "tags": [ "Accounts" ], "summary": "Transfer Between Accounts", "description": "Move funds in-between platform accounts. Use this endpoint to move funds between different accounts to trade in brokerage, or to withdraw later on.", "operationId": "transfer-between-accounts", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "ccy": "USDC", "from": "AVAILABLE", "to": "BROKERAGE", "amount": 250000 }, "schema": { "type": "object", "required": [ "tonce", "from", "to", "amount", "ccy", "accountGroupUuid" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "from": { "type": "string", "description": "Which account the funds are being transferred from. **Valid values**: `AVAILABLE` / `BROKERAGE`" }, "to": { "type": "string", "description": "Which account the funds are being transferred to. **Valid values**: `AVAILABLE` / `BROKERAGE`" }, "amount": { "type": "number", "description": "Amount to transfer.", "format": "double" }, "ccy": { "type": "string", "description": "Currency ticker to transfer." }, "accountGroupUuid": { "type": "string", "description": "specify which account group to perform the transfer upon" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\":\"OK\",\n \"uuid\":\"72e4d281-afsd-10b2-a549-d268892eahth3\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "OK" }, "uuid": { "type": "string", "example": "72e4d281-afsd-10b2-a549-d268892eahth3" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"INVALID_PARAMETERS\",\n \"timestamp\":\"1666588820606\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "INVALID_PARAMETERS" }, "timestamp": { "type": "string", "example": "1666588820606" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"timestamp\": \"1666418418989\",\n \"resultCode\": \"UNAUTHORISED\"\n}" } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "1666418418989" }, "resultCode": { "type": "string", "example": "UNAUTHORISED" } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"timestamp\": \"1666418418989\",\n \"resultCode\": \"UNAUTHORISED\"\n}" } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "1666418418989" }, "resultCode": { "type": "string", "example": "UNAUTHORISED" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"apiVersion\":\"1.0.0\",\n \"error\":\"SYSTEM_ERROR\",\n \"timestamp\":1666587269\n}" } }, "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "example": "1.0.0" }, "error": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "integer", "example": 1666587269, "default": 0 } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"SYSTEM_ERROR\",\n \"timestamp\":\"1666580244296\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "string", "example": "1666580244296" } } } } } } }, "deprecated": false } }, "/api/3/transaction/list": { "post": { "tags": [ "Accounts" ], "summary": "Get Transaction List", "description": "This endpoint allows users to retrieve a list of transactions done on the Zodia Markets platform", "operationId": "get-transactions", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "ccy": "USD", "transactionClass": "RFSTRADE", "max": 50, "offset": 0 }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "ccy": { "type": "string", "description": "Currency ticker (e.g. BTC, USD). Transactions are filtered on this currency only" }, "transactionState": { "type": "string", "description": "Return only transactions in this state - see reference above." }, "from": { "type": "integer", "description": "Start time (inclusive) of when transaction was created in system, format in Unix time in milliseconds.", "format": "int64" }, "to": { "type": "integer", "description": "End time (inclusive) of when transaction was created, format in Unix time in milliseconds.", "format": "int64" }, "max": { "type": "integer", "description": "Max results you want the endpoint to return. Note that it can be no greater than 200. Default value is 50 if not provided.", "default": 50, "format": "int32" }, "offset": { "type": "integer", "description": "Offset index. If you want to get beyond the first 200 transactions, you can use the offset value to get the next 200 transactions and so on.", "format": "int32" }, "accountGroupUuid": { "type": "string", "description": "Shows transactions specific to account group transactions" }, "transactionClass": { "type": "string", "description": "The class to filter on - see reference above" }, "transactionType": { "type": "string", "description": "Filter by the type of transaction - see reference above" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "OTCTRADE": { "value": { "transactionClass": "OTCTRADE", "uuid": "35fcee6a-6e69-46f9-857c-bd36c6267762", "userUuid": "2e5067d2-d639-46f5-88c3-2a6c3d6f47fb", "amount": 2000000, "fee": 0, "balanceBefore": 0, "balanceAfter": 0, "ccy": "USDC", "transactionState": "PENDING", "transactionType": "TRADE_CREDIT", "received": "1727349012726", "processed": "1727349012726", "timestampMillis": "1738759030201", "displayTitle": "OTC Trade Executed", "displayDescription": "", "customRef": "", "tradeRef": "ZODIA-CLIENT1-26SEP2024-120952-USDC-USD", "settleDate": "2025-09-26" } }, "RFSTRADE": { "value": " {\n \"transactionClass\": \"RFSTRADE\",\n \"uuid\": \"064ed768-e766-4cc2-8d75-bcae95790a67\",\n \"userUuid\": \"2073252c-81ed-41be-bf4d-d51b8f2246b8\",\n \"accountGroupUuid\": \"2073252c-81ed-41be-bf4d-d51b8f2246b8\",\n \"amount\": 1008.80000000,\n \"fee\": 0E-8,\n \"balanceBefore\": 0.0,\n \"balanceAfter\": 0.0,\n \"ccy\": \"USD\",\n \"transactionState\": \"PROCESSED\",\n \"transactionType\": \"TRADE_CREDIT\",\n \"received\": \"1773246361000\",\n \"processed\": \"1773246362578\",\n \"timestampMillis\": \"1773251007134\",\n \"displayTitle\": \"RFS Trade Executed\",\n \"displayDescription\": \"\",\n \"customRef\": \"5abc86ae-53cd-4f31-bbf4-8e598c7f6805\",\n \"quoteId\": \"Nu5EdH+siTnz9chTNyBbRDhVCD0vUhCV7gJgDFYKND8yQSUsYxwCBgAqcDAxNCZFDyEQYxx9GqrLIWQTMPuPPjECbz8hBhERayt6dD1lAmliNBM45QXlNUXmVUSf8Hxoo4CgkAK14WmX/W51HNwfubQ8fvwewCQ3JVwLPjf2GDMXNAM1OTE3BlgiBC86dwR5WAQVWiUqGiIzKar7oAWWKSciaXE8FTU8IUtKTisRPRU+ARMSOgRbOBNZMwkbTH0XQkBrJxJFUi4mAic6SG5fYE96UjgFJ1ROWHwwARdoCzAnLBwgXV8PPQcxWyI1Rw8eIDxbSj4mCy8KO1oYD1YLdQogMjM=\",\n \"executedPrice\": \"[USDC/USD] 0.99980000\",\n \"tradeRef\": \"ce0399cf4c4742b4969ba14534ba3009\",\n \"settleDate\": \"2026-03-11\",\n \"beneficiary\": {\n \"uuid\": \"52bb6368-6355-4022-8204-88a3cfb912e0\",\n \"name\": \"TEST TAZAPAY BENEFICIARY\"\n },\n \"networkId\": \"TAZAPAY\",\n \"paymentReason\": \"VASA\"\n }," }, "COIN": { "value": " {\n \"transactionClass\": \"COIN\",\n \"uuid\": \"b2a3b8d0-e302-4c09-9b3e-86f2229a78ac\",\n \"userUuid\": \"2e5037d2-d839-4df5-88c3-2a9c3d6f47fb\",\n \"amount\": 2.00000000,\n \"fee\": 0E-8,\n \"balanceBefore\": 0.0,\n \"balanceAfter\": 0.0,\n \"ccy\": \"ETH\",\n \"transactionState\": \"PROCESSED\",\n \"transactionType\": \"DEPOSIT\",\n \"received\": \"1738758250952\",\n \"processed\": \"1738758250952\",\n \"timestampMillis\": \"1738759441954\",\n \"displayTitle\": \"\",\n \"displayDescription\": \"\"\n }" }, "CASH": { "value": " {\n \"transactionClass\": \"CASH\",\n \"uuid\": \"b9ab666e-46f9-4285-892c-0a282e266236\",\n \"userUuid\": \"2e660712-d839-4df5-88c3-2a944d6f47fb\",\n \"amount\": 10000.00000000,\n \"fee\": 0E-8,\n \"balanceBefore\": 0.0,\n \"balanceAfter\": 0.0,\n \"ccy\": \"SGD\",\n \"transactionState\": \"PROCESSED\",\n \"transactionType\": \"DEPOSIT\",\n \"received\": \"1738083497144\",\n \"processed\": \"1738083571356\",\n \"timestampMillis\": \"1738759304531\",\n \"displayTitle\": \"Cash Payment In\",\n \"displayDescription\": \"\",\n \"paymentTransferType\": \"BANK_WIRE\"\n }" } }, "schema": { "oneOf": [ { "title": "OTCTRADE", "type": "object", "properties": { "transactionClass": { "type": "string", "example": "OTCTRADE", "description": "See transactionClass description" }, "uuid": { "type": "string", "example": "35fcee6a-6e69-46f9-857c-bd36c6267762", "description": "Unique identifier of transaction" }, "userUuid": { "type": "string", "example": "2e5067d2-d639-46f5-88c3-2a6c3d6f47fb", "description": "Trader who placed the trade" }, "amount": { "type": "integer", "example": 2000000, "default": 0, "description": "Quantity of trade" }, "fee": { "type": "integer", "example": 0, "default": 0, "description": "Usually 0" }, "balanceBefore": { "type": "integer", "example": 0, "default": 0, "description": "Balance before trade executed" }, "balanceAfter": { "type": "integer", "example": 0, "default": 0, "description": "Balance after trade executed" }, "ccy": { "type": "string", "example": "USDC", "description": "Currency" }, "transactionState": { "type": "string", "example": "PENDING", "description": "See transactionState descriptions" }, "transactionType": { "type": "string", "example": "TRADE_CREDIT", "description": "See transactionType descriptions" }, "received": { "type": "string", "example": "1727349012726", "description": "Datetime created timestamp" }, "processed": { "type": "string", "example": "1727349012726", "description": "Datetime processed (settled) timestamp" }, "timestampMillis": { "type": "string", "example": "1738759030201" }, "displayTitle": { "type": "string", "example": "OTC Trade Executed", "description": "Description of transaction" }, "displayDescription": { "type": "string", "example": "", "description": "Additional description" }, "customRef": { "type": "string", "example": "", "description": "Customer provided trade ref" }, "tradeRef": { "type": "string", "example": "ZODIA-CLIENT1-26SEP2024-120952-USDC-USD", "description": "The Zodia Markets trade reference for the trade this transaction belongs to. It is the value to send as `tradeRef` on [Get Trades List](https://docs.zodiamarkets.com/reference/get-trades-list) to retrieve the trade itself." }, "accountGroupUuid": { "type": "string", "description": "UUID of Account Group transaction was executed on" }, "settleDate": { "type": "string", "description": "The expected date of settlement for trade" }, "sender": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Identifier of entity that sent the funds for the trade" }, "name": { "type": "string", "description": "Name of entity that sent the funds for the trade" } }, "description": "Details of entity that sent the funds for the trade" }, "networkId": { "type": "string", "description": "Name of network used for payment" } } }, { "title": "RFSTRADE", "type": "object", "properties": { "transactionClass": { "type": "string", "example": "RFSTRADE", "description": "See description" }, "uuid": { "type": "string", "example": "ecd54451-f4fb-44b5-b415-95440fbb5f07", "description": "Unique reference" }, "userUuid": { "type": "string", "example": "2e5227d2-d839-4df5-88c3-2a223d6f47fb", "description": "Trader who entered the trade" }, "amount": { "type": "number", "example": -8587588.8, "default": 0, "description": "Quantity of trade leg" }, "fee": { "type": "integer", "example": 0, "default": 0, "description": "Usually 0" }, "balanceBefore": { "type": "integer", "example": 0, "default": 0, "description": "Balance before trade executed" }, "balanceAfter": { "type": "integer", "example": 0, "default": 0, "description": "Balance after trade executed" }, "ccy": { "type": "string", "example": "AED", "description": "Currency" }, "transactionState": { "type": "string", "example": "PROCESSED", "description": "See description" }, "transactionType": { "type": "string", "example": "TRADE_DEBIT", "description": "See description" }, "received": { "type": "string", "example": "1738162142060", "description": "Timestamp created" }, "processed": { "type": "string", "example": "1738162205130", "description": "Timestamped settled" }, "timestampMillis": { "type": "string", "example": "1738759201572" }, "displayTitle": { "type": "string", "example": "RFS Trade Executed", "description": "Transaction description" }, "displayDescription": { "type": "string", "example": "", "description": "Additional description" }, "customRef": { "type": "string", "example": "6758c624-965b-4587-b1e8-306dd4bd84c1", "description": "Reference provided via API" }, "quoteId": { "type": "string", "example": "OapZ6oK54FC3Hl4Il+8l16IXdIz1XKbzWqVqBgxHK5C6zF/WEB8Ej8uIxuZvVyLKbGc9tyeXsZmZmqCsQgN6EBgDKipnHCwJMlRvYjpKQUlgAysQOf2KNFC2bGIk/STnElQTPFpPQb0mF+bqEmVU9AxCyK4eUjOJ111EY6hYfUkBkYqtLBQBcXpROA8MVB4kFyQ3C19mAF4qAAF1ABs7FBQSKykqACgAKgATPgQXAAQEQwAxKQ4DBHcfEB8MEAJlbxgrIRBcAw89Uit7Lhw5XzkSOh89Hyp1PhktBBsdLQ86GiwUCAMTEAgROAQ6AD4uFAw8AAAfA2UABisLEAI5NXMYAAA=_client", "description": "Quote ID executed on via API" }, "executedPrice": { "type": "string", "example": "[USDC/AED] 3.93794400", "description": "Price executed" }, "tradeRef": { "type": "string", "example": "e9d838d6a1824729a4297853b394da36_client", "description": "The Zodia Markets trade reference for the trade this transaction belongs to. It is the value to send as `tradeRef` on [Get Trades List](https://docs.zodiamarkets.com/reference/get-trades-list) to retrieve the trade itself." }, "accountGroupUuid": { "type": "string", "description": "UUID of account group transaction was executed on" }, "settleDate": { "type": "string", "description": "The expected date of settlement for the trade" }, "beneficiary": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier for beneficiary the trade is to be delivered to" }, "name": { "type": "string", "description": "Name of the beneficiary the trade is to be delivered to" } }, "description": "Only applicable when making a payment transaction." }, "networkId": { "type": "string", "description": "Only applicable for 3rd party payment trades. Name of network used to facilitate trade " }, "paymentReason": { "type": "string", "description": "Only applicable for 3rd party payment trades. ISO code denoting the payment reason", "enum": [ "VASA", "INVS", "NETT", "TREA", "PLPR", "PLRE", "RENT", "UTIL", "GDSV", "SUPP", "SERV", "SUBS", "ADVA", "GIFT", "CASH", "CHAR", "OTHR", "SAVE", "LOAN", "TAXS", "FEXP", "SALA", "PENS" ] } } }, { "title": "COIN", "type": "object", "properties": { "transactionClass": { "type": "string", "example": "COIN" }, "uuid": { "type": "string", "example": "b2a3b8d0-e302-4c09-9b3e-86f2229a78ac" }, "userUuid": { "type": "string", "example": "2e5037d2-d839-4df5-88c3-2a9c3d6f47fb" }, "amount": { "type": "integer", "example": 2, "default": 0 }, "fee": { "type": "integer", "example": 0, "default": 0 }, "balanceBefore": { "type": "integer", "example": 0, "default": 0 }, "balanceAfter": { "type": "integer", "example": 0, "default": 0 }, "ccy": { "type": "string", "example": "ETH" }, "transactionState": { "type": "string", "example": "PROCESSED" }, "transactionType": { "type": "string", "example": "DEPOSIT" }, "received": { "type": "string", "example": "1738758250952" }, "processed": { "type": "string", "example": "1738758250952" }, "timestampMillis": { "type": "string", "example": "1738759441954" }, "displayTitle": { "type": "string", "example": "" }, "displayDescription": { "type": "string", "example": "" }, "coinAddress": { "type": "string", "description": "Source Address of coin transaction" }, "coinTransactionId": { "type": "string", "description": "The blockchain transaction hash for this coin movement." }, "sender": { "type": "object", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" } }, "description": "Entity that deposited the coin" } } }, { "title": "CASH", "type": "object", "properties": { "transactionClass": { "type": "string", "example": "CASH" }, "uuid": { "type": "string", "example": "b9ab666e-46f9-4285-892c-0a282e266236" }, "userUuid": { "type": "string", "example": "2e660712-d839-4df5-88c3-2a944d6f47fb" }, "amount": { "type": "integer", "example": 10000, "default": 0 }, "fee": { "type": "integer", "example": 0, "default": 0 }, "balanceBefore": { "type": "integer", "example": 0, "default": 0 }, "balanceAfter": { "type": "integer", "example": 0, "default": 0 }, "ccy": { "type": "string", "example": "SGD" }, "transactionState": { "type": "string", "example": "PROCESSED" }, "transactionType": { "type": "string", "example": "DEPOSIT" }, "received": { "type": "string", "example": "1738083497144" }, "processed": { "type": "string", "example": "1738083571356" }, "timestampMillis": { "type": "string", "example": "1738759304531" }, "displayTitle": { "type": "string", "example": "Cash Payment In" }, "displayDescription": { "type": "string", "example": "" }, "paymentTransferType": { "type": "string", "example": "BANK_WIRE" } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"INVALID_PARAMETERS\",\n \"timestamp\":\"1666521119313\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "INVALID_PARAMETERS" }, "timestamp": { "type": "string", "example": "1666521119313" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"UNAUTHORISED\",\n \"timestamp\":\"1666521142498\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "UNAUTHORISED" }, "timestamp": { "type": "string", "example": "1666521142498" } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"UNAUTHORISED\",\n \"timestamp\":\"1666521142498\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "UNAUTHORISED" }, "timestamp": { "type": "string", "example": "1666521142498" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"apiVersion\":\"1.0.0\",\n \"error\":\"SYSTEM_ERROR\",\n \"timestamp\":1666587269\n}" } }, "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "example": "1.0.0" }, "error": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "integer", "example": 1666587269, "default": 0 } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"resultCode\":\"SYSTEM_ERROR\",\n \"timestamp\":\"1666580244296\"\n}" } }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "SYSTEM_ERROR" }, "timestamp": { "type": "string", "example": "1666580244296" } } } } } } }, "deprecated": false } }, "/api/3/account": { "post": { "tags": [ "Accounts" ], "summary": "Get Account Balances", "description": "Retrieve account balances across all account groups (sub-accounts). Returns balances for each currency held within each account group, along with balance buckets.", "operationId": "get-account-information", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "filterZeroBalanceAccounts": true }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "nonce": { "type": "integer", "description": "Alternative to `tonce`. Every request must carry either `nonce` or `tonce`, and the value must parse as a whole number; a request with neither is rejected with `INVALID_NONCE_OR_TONCE`.", "format": "int64" }, "filterZeroBalanceAccounts": { "type": "boolean", "description": "When true, omits accounts whose balance is not greater than zero. This narrows `Account_Groups` only; `Wallets` and `Secondary_Wallets` ignore it entirely. When false or omitted, a zero-balance account is still returned if its currency is supported for your site. **Strongly recommended.**", "default": false }, "accountGroupUuid": { "type": "string", "description": "Restricts `Account_Groups` to the single account group with this UUID. Like `filterZeroBalanceAccounts`, it narrows `Account_Groups` only; `Wallets` and `Secondary_Wallets` ignore it entirely." }, "userUuid": { "type": "string", "description": "Master API keys only: UUID of the user to act on behalf of. Ignored unless the calling key belongs to the owner of a master-API-enabled site." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "Created": "2025-02-12 09:39:19", "Language": "en_US", "Login": "user@example.com", "Rights": [ "trade", "withdraw", "get_info" ], "Account_Groups": [ { "AccountGroup_Uuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "AccountGroup_Name": "Default", "Owner_Uuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "Owner_Name": "user@example.com", "Owner_Shortcode": "CLIENTCODE", "Natural": true, "Accounts": { "BTC": { "Balance": { "displayShort": "2.34 BTC", "valueInt": "233581881", "currency": "BTC", "display": "2.33581881 BTC", "value": "2.33581881" }, "Available_Balance": { "displayShort": "0.00 BTC", "valueInt": "0", "currency": "BTC", "display": "0.00000000 BTC", "value": "0.00000000" }, "Brokerage_Available_Balance": { "displayShort": "0.01 BTC", "valueInt": "1000000", "currency": "BTC", "display": "0.01000000 BTC", "value": "0.01000000" }, "Unsettled_Sell_Balance": { "displayShort": "0.13 BTC", "valueInt": "12769904", "currency": "BTC", "display": "0.12769904 BTC", "value": "0.12769904" }, "Unsettled_Buy_Balance": { "displayShort": "2.45 BTC", "valueInt": "245351785", "currency": "BTC", "display": "2.45351785 BTC", "value": "2.45351785" }, "ccy": "BTC", "Owner_Uuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "Uuid": "3c8c14ac-a8a6-4052-8857-c35719a189bf" }, "USDC": { "Balance": { "displayShort": "430,094.49 USDC", "valueInt": "43009448630600", "currency": "USDC", "display": "430,094.48630600 USDC", "value": "430094.48630600" }, "Available_Balance": { "displayShort": "0.00 USDC", "valueInt": "0", "currency": "USDC", "display": "0.00000000 USDC", "value": "0.00000000" }, "Brokerage_Available_Balance": { "displayShort": "78,834.01 USDC", "valueInt": "7883400788000", "currency": "USDC", "display": "78,834.00788000 USDC", "value": "78834.00788000" }, "Unsettled_Sell_Balance": { "displayShort": "10,000.00 USDC", "valueInt": "1000000000000", "currency": "USDC", "display": "10,000.00000000 USDC", "value": "10000.00000000" }, "Unsettled_Buy_Balance": { "displayShort": "361,260.48 USDC", "valueInt": "36126047842600", "currency": "USDC", "display": "361,260.47842600 USDC", "value": "361260.47842600" }, "ccy": "USDC", "Owner_Uuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "Uuid": "3bce6bba-2cc1-4590-b1fa-f659febde4cc" } } }, { "AccountGroup_Uuid": "afe6280e-163a-4652-a795-34e963063b06", "AccountGroup_Name": "SubAccount1", "Owner_Uuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "Owner_Name": "user@example.com", "Owner_Shortcode": "CLIENTCODE", "Natural": false, "Accounts": { "HKD": { "Balance": { "displayShort": "32,714.08 HKD", "valueInt": "3271408000", "currency": "HKD", "display": "32,714.08000 HKD", "value": "32714.08000" }, "Available_Balance": { "displayShort": "0.00 HKD", "valueInt": "0", "currency": "HKD", "display": "0.00000 HKD", "value": "0.00000" }, "Brokerage_Available_Balance": { "displayShort": "16,357.04 HKD", "valueInt": "1635704000", "currency": "HKD", "display": "16,357.04000 HKD", "value": "16357.04000" }, "Unsettled_Sell_Balance": { "displayShort": "0.00 HKD", "valueInt": "0", "currency": "HKD", "display": "0.00000 HKD", "value": "0.00000" }, "Unsettled_Buy_Balance": { "displayShort": "16,357.04 HKD", "valueInt": "1635704000", "currency": "HKD", "display": "16,357.04000 HKD", "value": "16357.04000" }, "ccy": "HKD", "Owner_Uuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "Uuid": "eae35b24-14fe-4210-ac87-618fb3da7613" } } } ] }, "userUuid": "db25fe1f-4be3-4a30-bed4-456a8e82a9b0", "timestamp": "1770888183656", "resultCode": "OK" } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "Account data container", "properties": { "Created": { "type": "string", "description": "Account creation date" }, "Language": { "type": "string", "description": "Account language locale" }, "Last_Login": { "type": "string", "description": "Date of the most recent login for this user" }, "Login": { "type": "string", "description": "API user login email" }, "Rights": { "type": "array", "description": "List of permissions on the API user: `trade`, `withdraw`, `get_info`", "items": { "type": "string" } }, "Wallets": { "type": "object", "deprecated": true, "description": "Legacy per-currency balances for the caller's own natural account group. Deprecated - use Account_Groups. Always present in the response, but an empty object when the caller owns no natural account group, which is always the case for subordinate users. Keyed by currency only." }, "Secondary_Wallets": { "type": "object", "deprecated": true, "description": "Legacy per-currency balances for account groups other than the caller's own natural one. Deprecated - use Account_Groups. Always present in the response, but an empty object when the caller belongs to no other account group. Keyed by currency only, so an entry is lost when the same currency is held in more than one of those groups." }, "Account_Groups": { "type": "array", "description": "Array of account group objects containing balances", "items": { "type": "object", "properties": { "AccountGroup_Uuid": { "type": "string", "description": "Unique identifier for the account group" }, "AccountGroup_Name": { "type": "string", "description": "Account group name (e.g., \"Default\", sub-account names)" }, "Owner_Uuid": { "type": "string", "description": "UUID of the account owner" }, "Owner_Name": { "type": "string", "description": "Owner (Parent) email address" }, "Owner_Shortcode": { "type": "string", "description": "Client shortcode identifier" }, "Natural": { "type": "boolean", "description": "`true` for the primary (default) account group, `false` for sub-accounts" }, "Accounts": { "type": "object", "description": "Map of currency codes to account balance objects — see \"Account Balance Object\" below for the shape of each value", "additionalProperties": { "type": "object", "properties": { "Balance": { "type": "object", "description": "Total balance including unsettled amounts", "properties": { "displayShort": { "type": "string", "description": "Abbreviated formatted balance (e.g., `\"2.34 BTC\"`)" }, "valueInt": { "type": "string", "description": "Integer representation of the balance (smallest unit)" }, "currency": { "type": "string", "description": "Currency code" }, "display": { "type": "string", "description": "Full precision formatted balance (e.g., `\"2.33581881 BTC\"`)" }, "value": { "type": "string", "description": "Decimal string value of the balance" } } }, "Available_Balance": { "type": "object", "description": "Balance available for withdrawal", "properties": { "displayShort": { "type": "string", "description": "Abbreviated formatted balance (e.g., `\"2.34 BTC\"`)" }, "valueInt": { "type": "string", "description": "Integer representation of the balance (smallest unit)" }, "currency": { "type": "string", "description": "Currency code" }, "display": { "type": "string", "description": "Full precision formatted balance (e.g., `\"2.33581881 BTC\"`)" }, "value": { "type": "string", "description": "Decimal string value of the balance" } } }, "Brokerage_Available_Balance": { "type": "object", "description": "Balance available for trading", "properties": { "displayShort": { "type": "string", "description": "Abbreviated formatted balance (e.g., `\"2.34 BTC\"`)" }, "valueInt": { "type": "string", "description": "Integer representation of the balance (smallest unit)" }, "currency": { "type": "string", "description": "Currency code" }, "display": { "type": "string", "description": "Full precision formatted balance (e.g., `\"2.33581881 BTC\"`)" }, "value": { "type": "string", "description": "Decimal string value of the balance" } } }, "Unsettled_Sell_Balance": { "type": "object", "description": "Pending sell trade amounts awaiting settlement", "properties": { "displayShort": { "type": "string", "description": "Abbreviated formatted balance (e.g., `\"2.34 BTC\"`)" }, "valueInt": { "type": "string", "description": "Integer representation of the balance (smallest unit)" }, "currency": { "type": "string", "description": "Currency code" }, "display": { "type": "string", "description": "Full precision formatted balance (e.g., `\"2.33581881 BTC\"`)" }, "value": { "type": "string", "description": "Decimal string value of the balance" } } }, "Unsettled_Buy_Balance": { "type": "object", "description": "Pending buy trade amounts awaiting settlement", "properties": { "displayShort": { "type": "string", "description": "Abbreviated formatted balance (e.g., `\"2.34 BTC\"`)" }, "valueInt": { "type": "string", "description": "Integer representation of the balance (smallest unit)" }, "currency": { "type": "string", "description": "Currency code" }, "display": { "type": "string", "description": "Full precision formatted balance (e.g., `\"2.33581881 BTC\"`)" }, "value": { "type": "string", "description": "Decimal string value of the balance" } } }, "ccy": { "type": "string", "description": "Currency code" }, "Owner_Uuid": { "type": "string", "description": "UUID of the account owner" }, "Uuid": { "type": "string", "description": "Unique identifier for this account" } } } } } } } } }, "userUuid": { "type": "string", "description": "Unique identifier for the API user" }, "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds)" }, "resultCode": { "type": "string", "description": "Result status (`OK` on success)" }, "description": { "type": "string", "description": "Failure reason. Present only on the error path; absent on success." } } } } } }, "400": { "description": "Malformed body, or a missing/stale `nonce`/`tonce`. Note that `resultCode` is hard-coded to `INVALID_PARAMETERS` on every failure of this endpoint regardless of cause — only the HTTP status distinguishes them, and `description` carries the reason text.", "content": { "application/json": { "examples": { "Result": { "value": { "timestamp": "1770888183656", "resultCode": "INVALID_PARAMETERS", "description": "wrong nonce" } } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Always `INVALID_PARAMETERS` on this endpoint, whatever the real cause.", "example": "INVALID_PARAMETERS" }, "description": { "type": "string", "description": "Reason text for the failure." } } } } } }, "401": { "description": "The key authenticated but is not authorised for this call.", "content": { "application/json": { "examples": { "Result": { "value": { "timestamp": "1770888183656", "resultCode": "INVALID_PARAMETERS", "description": "wrong nonce" } } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Always `INVALID_PARAMETERS` on this endpoint, whatever the real cause.", "example": "INVALID_PARAMETERS" }, "description": { "type": "string", "description": "Reason text for the failure." } } } } } }, "403": { "description": "The key could not be authenticated: unknown, deactivated, locked, expired, or wrong site.", "content": { "application/json": { "examples": { "Result": { "value": { "timestamp": "1770888183656", "resultCode": "INVALID_PARAMETERS", "description": "wrong nonce" } } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Always `INVALID_PARAMETERS` on this endpoint, whatever the real cause.", "example": "INVALID_PARAMETERS" }, "description": { "type": "string", "description": "Reason text for the failure." } } } } } }, "429": { "description": "The user has exceeded the request rate limit.", "content": { "application/json": { "examples": { "Result": { "value": { "timestamp": "1770888183656", "resultCode": "INVALID_PARAMETERS", "description": "wrong nonce" } } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Always `INVALID_PARAMETERS` on this endpoint, whatever the real cause.", "example": "INVALID_PARAMETERS" }, "description": { "type": "string", "description": "Reason text for the failure." } } } } } }, "500": { "description": "The request could not be validated.", "content": { "application/json": { "examples": { "Result": { "value": { "timestamp": "1770888183656", "resultCode": "INVALID_PARAMETERS", "description": "wrong nonce" } } }, "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Always `INVALID_PARAMETERS` on this endpoint, whatever the real cause.", "example": "INVALID_PARAMETERS" }, "description": { "type": "string", "description": "Reason text for the failure." } } } } } } }, "deprecated": false } }, "/api/3/trades": { "post": { "tags": [ "Trading" ], "summary": "Get Trades List", "description": "Retrieve a list of executed trades with optional filtering. Returns a single record for each trade, whilst the transaction endpoint returns a separate record for each leg of the trade.", "operationId": "get-trades-list", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "from": "2026-04-01T00:00:00Z", "to": "2026-04-30T23:59:59Z", "tradeState": "PENDING_SETTLEMENT", "max": 50, "offset": 0 }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "nonce": { "type": "integer", "description": "Alternative to `tonce`. Every request must carry either `nonce` or `tonce`, and the value must parse as a whole number; a request with neither is rejected with `INVALID_NONCE_OR_TONCE`.", "format": "int64" }, "tradeRef": { "type": "string", "description": "Filter by Zodia Markets trade reference" }, "clientRef": { "type": "string", "description": "Filter by your custom client reference" }, "tradeState": { "type": "string", "description": "Filter by trade state", "enum": [ "CANCELLED", "PROCESSED", "PENDING_SETTLEMENT" ] }, "tradeSide": { "type": "string", "description": "Filter by trade side", "enum": [ "BUY", "SELL" ] }, "tradeClass": { "type": "string", "description": "Filter by trade class", "enum": [ "OTC", "RFS" ] }, "from": { "type": "string", "format": "date-time", "description": "Start date/time filter (ISO 8601 format) for `createdAt`" }, "to": { "type": "string", "format": "date-time", "description": "End date/time filter (ISO 8601 format) for `createdAt`" }, "accountGroupUuid": { "type": "string", "format": "uuid", "description": "Filter by specific account group UUID" }, "sortDirection": { "type": "string", "description": "Sort direction applied to the trade ordering", "enum": [ "ASC", "DESC" ], "default": "DESC" }, "max": { "type": "integer", "description": "Maximum results to return (1-200)", "default": 50, "format": "int32", "minimum": 1, "maximum": 200 }, "offset": { "type": "integer", "description": "Offset for pagination", "default": 0, "format": "int32" }, "userUuid": { "type": "string", "description": "Master API keys only: UUID of the user to act on behalf of. Ignored unless the calling key belongs to the owner of a master-API-enabled site." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": [ { "uuid": "5488fcd4-3ca3-11f1-a3e2-17462098afd7", "createdAt": "2026-04-20T10:25:35Z", "updatedAt": "2026-04-20T10:25:43Z", "tradeRef": "f3a964ad27074a9780b5010b3514d2e0", "clientRef": "8309ec3c-83a3-490c-aab5-4748d7436ad8", "tradeSide": "BUY", "settlementAmount": { "amount": 1001, "currency": "EUR" }, "tradedAmount": { "amount": 1175.04882, "currency": "USDC" }, "user": "TEST1", "executorLogin": "SUB-USDTTEST", "accountGroup": { "uuid": "9073262c-81ed-41be-bf4d-d51b8f2246b8", "name": "Default" }, "tradeClass": "RFS", "tradeState": "PENDING_SETTLEMENT", "settlementDate": "2026-04-20", "quoteId": "RqAXfadhm5Q0RIqVJF8gNjEvPiIxYEBf0+pMlAlwOxdTbiYrFgU8UzV2TlApMzUzDBkhGApDSoJBavG+Ea92CTUoKQ8LPzs+B0J5fgtUeCsjLzob+yDsFlb1byHWtS5kqrqMu27bCHgcdnypCP4whuk7ew8u1wGaDNN+1AXXA1rEEPuEJjA6DFYKMSEsDQceFxsDYGIWCxh6ETtMUTV7DxQFIyBWRlE5KigeSRQTK3UoBlgDEDUrQkZjWycNAwE2MwFNCWhISURJbjxYEVd5Lh0FVUh3VmEDJS9VEAk7N1JSBlYNDgE5OR0RcxYPXyQ9HQV2Ex0GJRIlLzgMCgoJFzs3PS4=", "beneficiary": { "uuid": "f4761297-1d77-4d08-a6ae-742bafb0d773", "name": "MY COMPANY NAME" }, "networkId": "ZM_TRANSFER", "executedPrice": "[USDC/EUR] 0.85187950", "paymentReason": "VASA" } ], "total": 1 } } }, "schema": { "oneOf": [ { "title": "Trade list", "type": "object", "properties": { "data": { "type": "array", "description": "Array of trade objects", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique trade identifier" }, "createdAt": { "type": "string", "format": "date-time", "description": "Trade creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" }, "tradeRef": { "type": "string", "description": "Zodia Markets trade reference" }, "clientRef": { "type": "string", "description": "Your custom client reference (if provided during RFS trade execution)" }, "tradeSide": { "type": "string", "description": "`BUY` or `SELL` from your perspective", "enum": [ "BUY", "SELL" ] }, "settlementAmount": { "type": "object", "description": "Amount to be settled (what you pay/receive)", "properties": { "amount": { "type": "number", "description": "Amount value" }, "currency": { "type": "string", "description": "Currency code (ISO 4217 for fiat, asset symbol for crypto)" } } }, "tradedAmount": { "type": "object", "description": "Amount traded (what you buy/sell)", "properties": { "amount": { "type": "number", "description": "Amount value" }, "currency": { "type": "string", "description": "Currency code (ISO 4217 for fiat, asset symbol for crypto)" } } }, "user": { "type": "string", "description": "User Account shortcode" }, "executorLogin": { "type": "string", "description": "Login username of the user who executed the trade. Present only where the trade carries an executing user; absent otherwise." }, "accountGroup": { "type": "object", "description": "Account group information", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Account group UUID" }, "name": { "type": "string", "description": "Account group name" } } }, "tradeClass": { "type": "string", "description": "Trade classification: `OTC` or `RFS`", "enum": [ "OTC", "RFS" ] }, "tradeState": { "type": "string", "description": "Current trade state", "enum": [ "CANCELLED", "PROCESSED", "PENDING_SETTLEMENT" ] }, "settlementDate": { "type": "string", "format": "date", "description": "Expected settlement date (YYYY-MM-DD)" }, "quoteId": { "type": "string", "description": "Quote ID from price stream (for RFS trades, not present for OTC)" }, "beneficiary": { "type": "object", "description": "Third-party beneficiary details (not present for standard settlement)", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Beneficiary UUID" }, "name": { "type": "string", "description": "Beneficiary name" } } }, "sender": { "type": "object", "description": "Third-party sender details (not present for standard settlement)", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Sender UUID" }, "name": { "type": "string", "description": "Sender name" } } }, "networkId": { "type": "string", "description": "Settlement network identifier (not present for standard settlement)" }, "executedPrice": { "type": "string", "description": "Execution price with currency pair" }, "paymentReason": { "type": "string", "description": "Payment Reason for third party receipt/delivery trades" } } } }, "total": { "type": "integer", "description": "Total number of trades matching the filter criteria" } } }, { "title": "Error — returned with HTTP 200", "type": "object", "description": "On a validation or authentication failure this endpoint renders an error body but does not set an error HTTP status: the response is still `200 OK` and the failure is reported only by `resultCode`. Clients must inspect `resultCode` rather than relying on the status code.", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Failure reason.", "enum": [ "INVALID_PARAMETERS", "UNAUTHORISED" ], "example": "INVALID_PARAMETERS" } } } ] } } } } }, "deprecated": false } }, "/api/3/zm/rest/orders/state": { "post": { "tags": [ "Trading" ], "summary": "Read Order State", "description": "Read the current state of your orders with a given `clientRequestId`. Available for every order you have placed over the WebSocket, whether or not it was sent with `autoSubscribe`.\n\nA read, sent as POST because the signed body carries the anti-replay `tonce`/`nonce`. The query string is not part of the signed path.", "operationId": "get-order-state", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } }, { "name": "clientRequestId", "in": "query", "description": "The `clientRequestId` you sent on the order. Not unique — it may match more than one order, so the response is always an array.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "nonce": { "type": "integer", "description": "Alternative to `tonce`. Every request must carry either `nonce` or `tonce`, and the value must parse as a whole number; a request with neither is rejected with `401`.", "format": "int64" } } }, "example": { "tonce": 1770888183656000 } } } }, "responses": { "200": { "description": "The matching orders, as a JSON array. An empty array when there are none.", "content": { "application/json": { "example": [ { "messageType": "orderState", "timestamp": 1728374758421, "transactionId": "774722250a694498b916b7bac07bb48e", "clientRequestId": "TESTCLIENT1", "orderStatus": "SUCCESS", "subscriptionStatus": "NOT_SUBSCRIBED", "sessionId": null, "message": "", "code": "" } ], "schema": { "type": "array", "items": { "type": "object", "required": [ "messageType", "timestamp", "transactionId", "clientRequestId", "orderStatus", "subscriptionStatus", "message", "code" ], "properties": { "messageType": { "type": "string", "description": "Always `orderState`", "example": "orderState" }, "timestamp": { "type": "integer", "format": "int64", "description": "When this response was produced, in milliseconds. **Not** the time of any order event — it is set as the record is serialised for your read.", "example": 1728374758421 }, "transactionId": { "type": "string", "description": "Zodia Markets transaction reference for the order", "example": "774722250a694498b916b7bac07bb48e" }, "clientRequestId": { "type": "string", "description": "Your identifier from the order request. Empty until the order has an outcome recorded, including on a lookup by `clientRequestId`.", "example": "TESTCLIENT1" }, "orderStatus": { "type": "string", "enum": [ "SUCCESS", "FAILED", "INDETERMINATE", "PENDING" ], "description": "Outcome of the order. `PENDING` means no outcome has been recorded yet, and is returned for orders on either delivery model. `INDETERMINATE` means the outcome is genuinely unknown and the order may have executed — do not re-place it.", "example": "SUCCESS" }, "subscriptionStatus": { "type": "string", "enum": [ "NOT_SUBSCRIBED", "SUBSCRIBED", "UNSUBSCRIBED" ], "description": "`NOT_SUBSCRIBED` for an order sent without `autoSubscribe`. `SUBSCRIBED` until you send `orderUnsubscribe`, then `UNSUBSCRIBED`.", "example": "NOT_SUBSCRIBED" }, "sessionId": { "type": "string", "description": "The session the order is bound to. `null` for an order sent without `autoSubscribe` — the field is present on the wire, carrying null." }, "message": { "type": "string", "description": "Outcome message, empty when there is none", "example": "" }, "code": { "type": "string", "description": "Outcome code, empty when there is none. See the [Response / Error Code Reference](https://docs.zodiamarkets.com/reference/code-reference).", "example": "" } } } } } } }, "400": { "description": "`clientRequestId` or `sessionId` breaches the identifier rules. A request missing a required header or query parameter is also rejected with 400, but by the framework and with a different body.", "content": { "application/json": { "example": { "resultCode": "BAD_REQUEST", "timestamp": "1656987491835" }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "UNAUTHORIZED" }, "timestamp": { "type": "string", "description": "Unix time in milliseconds, as a string", "example": "1656987491835" } } } } } }, "401": { "description": "Authentication failed. A bad signature, a missing or stale `tonce`/`nonce`, and a replayed one are not distinguished.", "content": { "application/json": { "example": { "resultCode": "UNAUTHORIZED", "timestamp": "1656987491835" }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "UNAUTHORIZED" }, "timestamp": { "type": "string", "description": "Unix time in milliseconds, as a string", "example": "1656987491835" } } } } } } }, "deprecated": false } }, "/api/3/zm/rest/orders": { "post": { "tags": [ "Trading" ], "summary": "List Orders", "description": "List your orders, optionally narrowed to one session. Covers orders on both delivery models.\n\nA read, sent as POST because the signed body carries the anti-replay `tonce`/`nonce`. The query string is not part of the signed path.", "operationId": "get-orders-list", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "query", "description": "Return only orders bound to this session. Omit it to return every order Zodia Markets is still holding for you.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "nonce": { "type": "integer", "description": "Alternative to `tonce`. Every request must carry either `nonce` or `tonce`, and the value must parse as a whole number; a request with neither is rejected with `401`.", "format": "int64" } } }, "example": { "tonce": 1770888183656000 } } } }, "responses": { "200": { "description": "The matching orders, as a JSON array. An empty array when there are none.", "content": { "application/json": { "example": [ { "messageType": "orderState", "timestamp": 1728374758421, "transactionId": "774722250a694498b916b7bac07bb48e", "clientRequestId": "TESTCLIENT1", "orderStatus": "SUCCESS", "subscriptionStatus": "SUBSCRIBED", "sessionId": "trading-desk-1", "message": "", "code": "" } ], "schema": { "type": "array", "items": { "type": "object", "required": [ "messageType", "timestamp", "transactionId", "clientRequestId", "orderStatus", "subscriptionStatus", "message", "code" ], "properties": { "messageType": { "type": "string", "description": "Always `orderState`", "example": "orderState" }, "timestamp": { "type": "integer", "format": "int64", "description": "When this response was produced, in milliseconds. **Not** the time of any order event — it is set as the record is serialised for your read.", "example": 1728374758421 }, "transactionId": { "type": "string", "description": "Zodia Markets transaction reference for the order", "example": "774722250a694498b916b7bac07bb48e" }, "clientRequestId": { "type": "string", "description": "Your identifier from the order request. Empty until the order has an outcome recorded, including on a lookup by `clientRequestId`.", "example": "TESTCLIENT1" }, "orderStatus": { "type": "string", "enum": [ "SUCCESS", "FAILED", "INDETERMINATE", "PENDING" ], "description": "Outcome of the order. `PENDING` means no outcome has been recorded yet, and is returned for orders on either delivery model. `INDETERMINATE` means the outcome is genuinely unknown and the order may have executed — do not re-place it.", "example": "SUCCESS" }, "subscriptionStatus": { "type": "string", "enum": [ "NOT_SUBSCRIBED", "SUBSCRIBED", "UNSUBSCRIBED" ], "description": "`NOT_SUBSCRIBED` for an order sent without `autoSubscribe`. `SUBSCRIBED` until you send `orderUnsubscribe`, then `UNSUBSCRIBED`.", "example": "NOT_SUBSCRIBED" }, "sessionId": { "type": "string", "description": "The session the order is bound to. `null` for an order sent without `autoSubscribe` — the field is present on the wire, carrying null." }, "message": { "type": "string", "description": "Outcome message, empty when there is none", "example": "" }, "code": { "type": "string", "description": "Outcome code, empty when there is none. See the [Response / Error Code Reference](https://docs.zodiamarkets.com/reference/code-reference).", "example": "" } } } } } } }, "400": { "description": "`clientRequestId` or `sessionId` breaches the identifier rules. A request missing a required header or query parameter is also rejected with 400, but by the framework and with a different body.", "content": { "application/json": { "example": { "resultCode": "BAD_REQUEST", "timestamp": "1656987491835" }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "UNAUTHORIZED" }, "timestamp": { "type": "string", "description": "Unix time in milliseconds, as a string", "example": "1656987491835" } } } } } }, "401": { "description": "Authentication failed. A bad signature, a missing or stale `tonce`/`nonce`, and a replayed one are not distinguished.", "content": { "application/json": { "example": { "resultCode": "UNAUTHORIZED", "timestamp": "1656987491835" }, "schema": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "UNAUTHORIZED" }, "timestamp": { "type": "string", "description": "Unix time in milliseconds, as a string", "example": "1656987491835" } } } } } } }, "deprecated": false } }, "/api/3/originator": { "post": { "tags": [ "Payment participants" ], "summary": "Get Account Details List", "description": "Retrieve account details for the entity you have onboarded with Zodia Markets ( details include You / Your Entity name, address, IDs) and list of wallets and bank accounts that have been whitelisted and verified with Zodia Markets for the entity.", "operationId": "get-account-details-list", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "limit": 50 }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "nonce": { "type": "integer", "description": "Alternative to `tonce`. Every request must carry either `nonce` or `tonce`, and the value must parse as a whole number; a request with neither is rejected with `INVALID_NONCE_OR_TONCE`.", "format": "int64" }, "accountGroupUuid": { "type": "string", "description": "Filter Account Details by specific account group UUID. Will return Default Account Group if not provided. **Note** only one Entity is returned per Account Group" }, "limit": { "type": "integer", "description": "Maximum results to return. Validation caps this at 50 — a larger value is rejected with `INVALID_PARAMETERS`. When omitted, the participants service applies its own default. This endpoint validates the value but then ignores it: it always requests a single record and returns that one object.", "format": "int32", "minimum": 0, "maximum": 50 }, "userUuid": { "type": "string", "description": "Master API keys only: UUID of the user to act on behalf of. Ignored unless the calling key belongs to the owner of a master-API-enabled site." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "companyName": "TECH COMPANY PLC", "dateOfFormation": "2021-02-09", "countryOfFormation": "GB", "countryOfRegistration": "GB", "uuid": "603a341f-73d3-41ab-9666-24166312e43d", "clientShortcode": "TESTACCOUNT", "clientAccountGroupName": "Default", "clientAccountGroupUuid": "7687282f-1073-441b-9ff4-694e6b49effe", "type": "ENTITY", "kind": "ORIGINATOR", "phoneNumber": "+4479878767898", "website": "www.techcompany112311.com", "email": "techcompany@emailprovider.com", "vasp": false, "enabled": true, "verified": true, "address": { "country": "GB", "city": "London", "street": "101 Test Street", "postalCode": "N5 POP", "stateProvince": "Greater London", "createdAt": "2026-05-12T17:00:00Z", "updatedAt": "2026-05-12T17:00:00Z" }, "kycDetails": { "occupation": "Service Provider", "sourceOfFunds": "Trading", "methodOfVerification": "Online", "industryType": "Technology", "entityType": "", "natureOfActivity": "Off-Ramp", "beneficiaryOwnership": false, "createdAt": "2026-05-12T16:59:58Z", "updatedAt": "2026-05-12T16:59:58Z" }, "associatedPersons": [ { "firstname": "Joe", "lastname": "Bloggs", "dateOfBirth": "2011-05-06", "countryOfOrigin": "GB", "nationality": "GB", "uuid": "a11b5beb-c1e2-4918-ace1-99373ddf70a6", "clientShortcode": "hassanLimitsUAT", "type": "INDIVIDUAL", "kind": "AUTHORIZED_SIGNATORY", "phoneNumber": "", "website": "", "email": "", "createdAt": "2026-05-12T16:59:52Z", "updatedAt": "2026-05-12T16:59:52Z" } ], "identifications": [ { "type": "OTHER", "number": "MS190987871B", "typeOther": "MSB", "createdAt": "2026-05-12T16:59:53Z", "updatedAt": "2026-05-12T16:59:53Z" }, { "type": "BUSINESS_REGISTRATION", "number": "1019098988", "typeOther": "", "createdAt": "2026-05-12T16:59:53Z", "updatedAt": "2026-05-12T16:59:53Z" } ], "bankAccounts": [ { "uuid": "aca1259e-1839-4c17-b612-82ebcc04d339", "bankName": "BACKUP BANK", "bankBranchName": "BACKUP BRANCH", "accountNumber": "109978736766", "accountAlias": "MY BACKUP BANK", "accountName": "TECH COMPANY PLC 2", "currency": "GBP", "iban": "GB0828972727222", "swiftBic": "BBXXX2L", "country": "GB", "city": "London", "street": "109 Bank Street", "postalCode": "EC1A AAB", "memo": "Please provide 2", "intermediaryBankCountry": "", "intermediaryBankSwiftBic": "", "enabled": true, "verified": true, "networkIds": [], "createdAt": "2026-05-12T16:59:50Z", "updatedAt": "2026-05-12T16:59:50Z" }, { "uuid": "903730c4-e6c3-452e-babd-d4743efb9b07", "bankName": "TECH BANK", "bankBranchName": "TECH BRANCH", "accountNumber": "101099991", "accountAlias": "MY TECH BANK 1", "accountName": "TECH COMP LTD", "currency": "GBP", "iban": "GB190198198887", "swiftBic": "TBXXX", "country": "GB", "city": "London", "street": "101 Bank Street", "postalCode": "EC1A AAA", "memo": "Provide Reference", "intermediaryBankCountry": "", "intermediaryBankSwiftBic": "", "enabled": true, "verified": true, "networkIds": [], "createdAt": "2026-05-12T16:59:51Z", "updatedAt": "2026-05-12T16:59:51Z" } ], "wallets": [ { "uuid": "f16186df-5cf5-4417-86eb-8cd65fab3348", "blockchain": "Ethereum", "asset": "USDC", "walletAddress": "0x982892872727", "alias": "MY USDC WALLET", "type": "SELF_HOSTED", "memo": "Main", "vasp": "", "executionProvider": "", "default": false, "enabled": true, "whitelisted": false, "createdAt": "2026-05-12T16:59:49Z", "updatedAt": "2026-05-12T16:59:49Z" }, { "uuid": "b4494718-ddb2-4554-a65c-e06e64875923", "blockchain": "TRON", "asset": "USDT", "walletAddress": "0x98287272772221", "alias": "MY WALLET USDT", "type": "CUSTODY", "memo": "FORWARD", "vasp": "ZODIA_CUSTODY", "executionProvider": "Zodia", "default": false, "enabled": true, "whitelisted": false, "createdAt": "2026-05-12T16:59:48Z", "updatedAt": "2026-05-12T16:59:48Z" } ], "createdAt": "2026-05-12T16:54:02Z", "updatedAt": "2026-05-12T16:54:02Z" } } }, "schema": { "oneOf": [ { "title": "Account details — `type: ENTITY`", "type": "object", "properties": { "companyName": { "type": "string", "description": "Entity name" }, "companyName2": { "type": "string", "description": "Second line of the registered name, where the name needs one" }, "dateOfFormation": { "type": "string", "format": "date", "description": "Company formation date (YYYY-MM-DD)" }, "countryOfFormation": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "countryOfRegistration": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the Entity" }, "type": { "type": "string", "description": "Whether this participant is a legal entity or a natural person", "enum": [ "ENTITY", "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Always `ORIGINATOR`", "enum": [ "ORIGINATOR" ] }, "enabled": { "type": "boolean", "description": "Whether Entity is enabled for trading" }, "verified": { "type": "boolean", "description": "Whether Entity has completed verification" }, "vasp": { "type": "boolean", "description": "Virtual Asset Service Provider flag" }, "ownershipPercentage": { "type": "string", "description": "Percentage of the participant owned, for participants held as an ownership interest. Absent when not recorded." }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "clientAccountGroupName": { "type": "string", "description": "Account group (sub-account) name" }, "clientAccountGroupUuid": { "type": "string", "description": "Account group UUID" }, "email": { "type": "string", "description": "Contact email" }, "phoneNumber": { "type": "string", "description": "Contact phone" }, "website": { "type": "string", "description": "Website URL" }, "address": { "type": "object", "description": "Address details", "properties": { "street": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City" }, "stateProvince": { "type": "string", "description": "State or province" }, "postalCode": { "type": "string", "description": "Postal/ZIP code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "kycDetails": { "type": "object", "description": "KYC and compliance information", "properties": { "occupation": { "type": "string", "description": "Occupation or business activity" }, "sourceOfFunds": { "type": "string", "description": "Source of funds description" }, "methodOfVerification": { "type": "string", "description": "Verification method used" }, "industryType": { "type": "string", "description": "Industry classification" }, "entityType": { "type": "string", "description": "Legal entity type" }, "natureOfActivity": { "type": "string", "description": "Nature of business activity" }, "beneficiaryOwnership": { "type": "boolean", "description": "Beneficiary ownership flag" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "identifications": { "type": "array", "description": "Business registration and tax identifications", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Identification type", "enum": [ "PASSPORT", "NATIONAL_ID", "DRIVERS_LICENSE", "SSN", "TAX_ID", "LEI", "EIN", "VAT_NUMBER", "BUSINESS_REGISTRATION", "OTHER" ] }, "number": { "type": "string", "description": "Identification number" }, "typeOther": { "type": "string", "description": "Custom type (if type is \"OTHER\")" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "associatedPersons": { "type": "array", "description": "Associated Person details (e.g. authorized signatory, beneficial owners). `enabled`, `verified` and `vasp` are always null on these entries.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the person" }, "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "type": { "type": "string", "description": "Always `INDIVIDUAL` for an associated person", "enum": [ "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Role this person holds in relation to the participant", "enum": [ "AUTHORIZED_SIGNATORY", "BENEFICIARY_OWNER", "INTERMEDIARY_BENEFICIARY_OWNER" ] }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "phoneNumber": { "type": "string", "description": "Contact phone" }, "website": { "type": "string", "description": "Website URL" }, "email": { "type": "string", "description": "Contact email" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "bankAccounts": { "type": "array", "description": "Bank accounts configured for fiat settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the bank account" }, "bankName": { "type": "string", "description": "Bank institution name" }, "bankBranchName": { "type": "string", "description": "Branch name" }, "accountNumber": { "type": "string", "description": "Bank account number" }, "accountAlias": { "type": "string", "description": "Friendly alias for the account" }, "accountName": { "type": "string", "description": "Account holder name" }, "currency": { "type": "string", "description": "Account currency (ISO 4217)" }, "iban": { "type": "string", "description": "International Bank Account Number" }, "swiftBic": { "type": "string", "description": "SWIFT/BIC code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "city": { "type": "string", "description": "Bank branch city" }, "street": { "type": "string", "description": "Bank branch street address" }, "postalCode": { "type": "string", "description": "Bank branch postal code" }, "memo": { "type": "string", "description": "Additional notes" }, "intermediaryBankCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the intermediary bank, where one is used" }, "intermediaryBankSwiftBic": { "type": "string", "description": "SWIFT/BIC code of the intermediary bank, where one is used" }, "enabled": { "type": "boolean", "description": "Whether account is enabled" }, "verified": { "type": "boolean", "description": "Whether account is verified" }, "networkIds": { "type": "array", "description": "Settlement networks this bank account may be used with", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "wallets": { "type": "array", "description": "Crypto wallet addresses for digital asset settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier" }, "blockchain": { "type": "string", "description": "Blockchain network (e.g., `Ethereum`, `Polygon`, `TRON`)" }, "asset": { "type": "string", "description": "Digital asset symbol (e.g., `USDC`, `USDT`, `BTC`)" }, "walletAddress": { "type": "string", "description": "Blockchain wallet address" }, "alias": { "type": "string", "description": "Friendly alias for the wallet" }, "type": { "type": "string", "description": "`SELF_HOSTED` or `CUSTODY`" }, "memo": { "type": "string", "description": "Additional notes" }, "vasp": { "type": "string", "description": "Virtual Asset Service Provider name (if custody)" }, "executionProvider": { "type": "string", "description": "Execution provider name (if applicable)" }, "default": { "type": "boolean", "description": "Whether this is the default wallet for the asset" }, "enabled": { "type": "boolean", "description": "Whether wallet is enabled for trading" }, "whitelisted": { "type": "boolean", "description": "Whether wallet address is whitelisted" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Entity creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, { "title": "Account details — `type: INDIVIDUAL`", "type": "object", "example": { "firstname": "Alex", "lastname": "Marchetti", "dateOfBirth": "1979-03-14", "countryOfOrigin": "GB", "nationality": "IT", "uuid": "cdfc3e0e-a27d-430f-be56-165f1a12e605", "clientShortcode": "TESTINDIVIDUAL", "clientAccountGroupName": "Default", "clientAccountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "type": "INDIVIDUAL", "kind": "ORIGINATOR", "phoneNumber": "+447700900142", "website": "", "email": "alex.marchetti@emailprovider.com", "vasp": false, "enabled": true, "verified": true, "ownershipPercentage": "100", "address": { "country": "GB", "city": "London", "street": "14 Test Row", "postalCode": "SW1A 1AA", "stateProvince": "Greater London", "createdAt": "2026-05-12T17:00:00Z", "updatedAt": "2026-05-12T17:00:00Z" }, "kycDetails": { "occupation": "Private Investor", "sourceOfFunds": "Investment Income", "methodOfVerification": "Online", "industryType": "Financial Services", "entityType": "", "natureOfActivity": "Off-Ramp", "beneficiaryOwnership": false, "createdAt": "2026-05-12T16:59:58Z", "updatedAt": "2026-05-12T16:59:58Z" }, "associatedPersons": [], "identifications": [ { "type": "PASSPORT", "number": "P1928374655", "typeOther": "", "createdAt": "2026-05-12T16:59:53Z", "updatedAt": "2026-05-12T16:59:53Z" } ], "bankAccounts": [ { "uuid": "c69c2829-102c-4b31-9e2f-e12c5e155d26", "bankName": "TEST BANK", "bankBranchName": "CITY BRANCH", "accountNumber": "20817264", "accountAlias": "MY CURRENT ACCOUNT", "accountName": "ALEX MARCHETTI", "currency": "GBP", "iban": "GB29TEST60161331926819", "swiftBic": "TESTGB2L", "country": "GB", "city": "London", "street": "1 Bank Street", "postalCode": "EC1A AAA", "memo": "", "intermediaryBankCountry": "", "intermediaryBankSwiftBic": "", "enabled": true, "verified": true, "networkIds": [], "createdAt": "2026-05-12T16:59:50Z", "updatedAt": "2026-05-12T16:59:50Z" } ], "wallets": [ { "uuid": "04d0c9a8-9ffd-4fb1-83ff-316ada2d1f4b", "blockchain": "Ethereum", "asset": "USDC", "walletAddress": "0x982892872727", "alias": "MY USDC WALLET", "type": "SELF_HOSTED", "memo": "Main", "vasp": "", "executionProvider": "", "default": true, "enabled": true, "whitelisted": true, "createdAt": "2026-05-12T16:59:49Z", "updatedAt": "2026-05-12T16:59:49Z" } ], "createdAt": "2026-05-12T16:59:48Z", "updatedAt": "2026-05-12T16:59:48Z" }, "properties": { "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the Entity" }, "type": { "type": "string", "description": "Whether this participant is a legal entity or a natural person", "enum": [ "ENTITY", "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Always `ORIGINATOR`", "enum": [ "ORIGINATOR" ] }, "enabled": { "type": "boolean", "description": "Whether Entity is enabled for trading" }, "verified": { "type": "boolean", "description": "Whether Entity has completed verification" }, "vasp": { "type": "boolean", "description": "Virtual Asset Service Provider flag" }, "ownershipPercentage": { "type": "string", "description": "Percentage of the participant owned, for participants held as an ownership interest. Absent when not recorded." }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "clientAccountGroupName": { "type": "string", "description": "Account group (sub-account) name" }, "clientAccountGroupUuid": { "type": "string", "description": "Account group UUID" }, "email": { "type": "string", "description": "Contact email" }, "phoneNumber": { "type": "string", "description": "Contact phone" }, "website": { "type": "string", "description": "Website URL" }, "address": { "type": "object", "description": "Address details", "properties": { "street": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City" }, "stateProvince": { "type": "string", "description": "State or province" }, "postalCode": { "type": "string", "description": "Postal/ZIP code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "kycDetails": { "type": "object", "description": "KYC and compliance information", "properties": { "occupation": { "type": "string", "description": "Occupation or business activity" }, "sourceOfFunds": { "type": "string", "description": "Source of funds description" }, "methodOfVerification": { "type": "string", "description": "Verification method used" }, "industryType": { "type": "string", "description": "Industry classification" }, "entityType": { "type": "string", "description": "Legal entity type" }, "natureOfActivity": { "type": "string", "description": "Nature of business activity" }, "beneficiaryOwnership": { "type": "boolean", "description": "Beneficiary ownership flag" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "identifications": { "type": "array", "description": "Business registration and tax identifications", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Identification type", "enum": [ "PASSPORT", "NATIONAL_ID", "DRIVERS_LICENSE", "SSN", "TAX_ID", "LEI", "EIN", "VAT_NUMBER", "BUSINESS_REGISTRATION", "OTHER" ] }, "number": { "type": "string", "description": "Identification number" }, "typeOther": { "type": "string", "description": "Custom type (if type is \"OTHER\")" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "associatedPersons": { "type": "array", "description": "Associated Person details (e.g. authorized signatory, beneficial owners). `enabled`, `verified` and `vasp` are always null on these entries.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the person" }, "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "type": { "type": "string", "description": "Always `INDIVIDUAL` for an associated person", "enum": [ "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Role this person holds in relation to the participant", "enum": [ "AUTHORIZED_SIGNATORY", "BENEFICIARY_OWNER", "INTERMEDIARY_BENEFICIARY_OWNER" ] }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "phoneNumber": { "type": "string", "description": "Contact phone" }, "website": { "type": "string", "description": "Website URL" }, "email": { "type": "string", "description": "Contact email" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "bankAccounts": { "type": "array", "description": "Bank accounts configured for fiat settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the bank account" }, "bankName": { "type": "string", "description": "Bank institution name" }, "bankBranchName": { "type": "string", "description": "Branch name" }, "accountNumber": { "type": "string", "description": "Bank account number" }, "accountAlias": { "type": "string", "description": "Friendly alias for the account" }, "accountName": { "type": "string", "description": "Account holder name" }, "currency": { "type": "string", "description": "Account currency (ISO 4217)" }, "iban": { "type": "string", "description": "International Bank Account Number" }, "swiftBic": { "type": "string", "description": "SWIFT/BIC code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "city": { "type": "string", "description": "Bank branch city" }, "street": { "type": "string", "description": "Bank branch street address" }, "postalCode": { "type": "string", "description": "Bank branch postal code" }, "memo": { "type": "string", "description": "Additional notes" }, "intermediaryBankCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the intermediary bank, where one is used" }, "intermediaryBankSwiftBic": { "type": "string", "description": "SWIFT/BIC code of the intermediary bank, where one is used" }, "enabled": { "type": "boolean", "description": "Whether account is enabled" }, "verified": { "type": "boolean", "description": "Whether account is verified" }, "networkIds": { "type": "array", "description": "Settlement networks this bank account may be used with", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "wallets": { "type": "array", "description": "Crypto wallet addresses for digital asset settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier" }, "blockchain": { "type": "string", "description": "Blockchain network (e.g., `Ethereum`, `Polygon`, `TRON`)" }, "asset": { "type": "string", "description": "Digital asset symbol (e.g., `USDC`, `USDT`, `BTC`)" }, "walletAddress": { "type": "string", "description": "Blockchain wallet address" }, "alias": { "type": "string", "description": "Friendly alias for the wallet" }, "type": { "type": "string", "description": "`SELF_HOSTED` or `CUSTODY`" }, "memo": { "type": "string", "description": "Additional notes" }, "vasp": { "type": "string", "description": "Virtual Asset Service Provider name (if custody)" }, "executionProvider": { "type": "string", "description": "Execution provider name (if applicable)" }, "default": { "type": "boolean", "description": "Whether this is the default wallet for the asset" }, "enabled": { "type": "boolean", "description": "Whether wallet is enabled for trading" }, "whitelisted": { "type": "boolean", "description": "Whether wallet address is whitelisted" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Entity creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, { "title": "Error — returned with HTTP 200", "type": "object", "description": "On a validation or authentication failure this endpoint renders an error body but does not set an error HTTP status: the response is still `200 OK` and the failure is reported only by `resultCode`. Clients must inspect `resultCode` rather than relying on the status code.", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Failure reason.", "enum": [ "INVALID_PARAMETERS", "UNAUTHORISED" ], "example": "INVALID_PARAMETERS" } } } ] } } } }, "404": { "description": "No originator record exists for the resolved account group. The response body is empty." } }, "deprecated": false } }, "/api/3/beneficiaries": { "post": { "tags": [ "Payment participants" ], "summary": "Get Beneficiary List", "description": "Retrieve a list of third-party beneficiaries configured for your account along with their verified crypto wallet addresses. Beneficiaries are external entities that can receive digital assets from your trades via third-party settlement.", "operationId": "get-beneficiary-list", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "limit": 50, "offset": 0 }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "nonce": { "type": "integer", "description": "Alternative to `tonce`. Every request must carry either `nonce` or `tonce`, and the value must parse as a whole number; a request with neither is rejected with `INVALID_NONCE_OR_TONCE`.", "format": "int64" }, "accountGroupUuid": { "type": "string", "description": "Filter beneficiaries by specific account group UUID" }, "limit": { "type": "integer", "description": "Maximum results to return. Validation caps this at 50 — a larger value is rejected with `INVALID_PARAMETERS`. When omitted, the participants service applies its own default.", "format": "int32", "minimum": 0, "maximum": 50 }, "offset": { "type": "integer", "description": "Offset for pagination", "format": "int32" }, "userUuid": { "type": "string", "description": "Master API keys only: UUID of the user to act on behalf of. Ignored unless the calling key belongs to the owner of a master-API-enabled site." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": [ { "companyName": "TECH COMPANY", "dateOfFormation": "2025-11-01", "countryOfFormation": "GB", "countryOfRegistration": "GB", "uuid": "5fff78ca-d87f-424f-90bf-96b1906a284b", "clientShortcode": "USDTTEST1", "clientAccountGroupName": "Default", "clientAccountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "type": "ENTITY", "kind": "BENEFICIARY", "phoneNumber": "(44)172799567", "website": "www.mytechcompany.com", "email": "tech@company.com", "vasp": true, "enabled": false, "verified": false, "address": { "country": "GB", "city": "London", "street": "21 Tech Street", "postalCode": "N5 YAY", "stateProvince": "Greater London", "createdAt": "2026-01-23T17:49:56Z", "updatedAt": "2026-01-23T17:49:56Z" }, "kycDetails": { "occupation": "Service Provider", "sourceOfFunds": "Trading", "methodOfVerification": "Electronic", "industryType": "Technology", "entityType": "NA", "natureOfActivity": "Fintech", "beneficiaryOwnership": false, "createdAt": "2026-01-23T17:49:55Z", "updatedAt": "2026-01-23T17:49:55Z" }, "identifications": [ { "type": "BUSINESS_REGISTRATION", "number": "EA990098771", "typeOther": "", "createdAt": "2026-01-23T17:49:52Z", "updatedAt": "2026-01-23T17:49:52Z" }, { "type": "LEI", "number": "12345678", "typeOther": "", "createdAt": "2026-01-23T17:49:52Z", "updatedAt": "2026-01-23T17:49:52Z" }, { "type": "TAX_ID", "number": "09898766", "typeOther": "", "createdAt": "2026-01-23T17:49:54Z", "updatedAt": "2026-01-23T17:49:54Z" } ], "bankAccounts": [ { "bankName": "STANDARD CHARTERED BANK GB", "bankBranchName": "STANDARD CHARTERED BASINGHALL", "accountNumber": "", "accountAlias": "Tech Company (UK) GBP", "accountName": "TECH COMPANY Account Main", "currency": "GBP", "iban": "GB07SCB60924280026876", "swiftBic": "SCBGLXXX", "country": "GB", "city": "London", "street": "1 Basinghall Avenue", "postalCode": "EC1 2LA", "memo": "TEST MEMO", "enabled": true, "verified": true, "createdAt": "2026-01-23T17:49:50Z", "updatedAt": "2026-01-23T17:49:50Z" } ], "wallets": [ { "uuid": "d1d6a755-e97e-4278-b246-2ea18a54ab60", "blockchain": "Polygon", "asset": "USDC", "walletAddress": "0x9882761678912", "alias": "TECH_USDC_POL", "type": "SELF_HOSTED", "memo": "Backup", "vasp": "", "executionProvider": "", "default": false, "enabled": true, "whitelisted": true, "createdAt": "2026-01-23T17:49:48Z", "updatedAt": "2026-01-23T17:50:32Z" }, { "uuid": "88ce5ff8-3199-4b8c-85e2-44d9da960abf", "blockchain": "Ethereum", "asset": "USDC", "walletAddress": "0x908728727777661", "alias": "TECH_USDC_MAIN-ETH", "type": "SELF_HOSTED", "memo": "Payments", "vasp": "", "executionProvider": "", "default": false, "enabled": true, "whitelisted": true, "createdAt": "2026-01-23T17:49:49Z", "updatedAt": "2026-01-23T17:50:31Z" }, { "uuid": "0e333c18-cbf1-4c26-8b9e-cdecce5e04bc", "blockchain": "TRON", "asset": "USDT", "walletAddress": "0x98887182891", "alias": "TECH_USDT_TRON", "type": "CUSTODY", "memo": "Payment2", "vasp": "COINBASE", "executionProvider": "BINANCE", "default": false, "enabled": true, "whitelisted": true, "createdAt": "2026-01-23T17:49:47Z", "updatedAt": "2026-01-23T17:50:30Z" } ], "createdAt": "2026-01-23T17:41:41Z", "updatedAt": "2026-01-23T17:41:41Z" } ] } } }, "schema": { "oneOf": [ { "title": "Beneficiary list — `type: ENTITY`", "type": "object", "properties": { "data": { "type": "array", "description": "Array of beneficiary objects", "items": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Beneficiary company/entity name" }, "companyName2": { "type": "string", "description": "Second line of the registered name, where the name needs one" }, "dateOfFormation": { "type": "string", "format": "date", "description": "Company formation date (YYYY-MM-DD)" }, "countryOfFormation": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "countryOfRegistration": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the Beneficiary" }, "type": { "type": "string", "description": "Whether this participant is a legal entity or a natural person", "enum": [ "ENTITY", "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Always `BENEFICIARY`", "enum": [ "BENEFICIARY" ] }, "enabled": { "type": "boolean", "description": "Whether Beneficiary is enabled for trading" }, "verified": { "type": "boolean", "description": "Whether Beneficiary has completed verification" }, "vasp": { "type": "boolean", "description": "Virtual Asset Service Provider flag" }, "ownershipPercentage": { "type": "string", "description": "Percentage of the participant owned, for participants held as an ownership interest. Absent when not recorded." }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "clientAccountGroupName": { "type": "string", "description": "Account group (sub-account) name" }, "clientAccountGroupUuid": { "type": "string", "description": "Account group UUID" }, "email": { "type": "string", "description": "Beneficiary contact email" }, "phoneNumber": { "type": "string", "description": "Beneficiary contact phone" }, "website": { "type": "string", "description": "Beneficiary website URL" }, "address": { "type": "object", "description": "Beneficiary address details", "properties": { "street": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City" }, "stateProvince": { "type": "string", "description": "State or province" }, "postalCode": { "type": "string", "description": "Postal/ZIP code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "kycDetails": { "type": "object", "description": "KYC and compliance information", "properties": { "occupation": { "type": "string", "description": "Occupation or business activity" }, "sourceOfFunds": { "type": "string", "description": "Source of funds description" }, "methodOfVerification": { "type": "string", "description": "Verification method used" }, "industryType": { "type": "string", "description": "Industry classification" }, "entityType": { "type": "string", "description": "Legal entity type" }, "natureOfActivity": { "type": "string", "description": "Nature of business activity" }, "beneficiaryOwnership": { "type": "boolean", "description": "Beneficiary ownership flag" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "identifications": { "type": "array", "description": "Business registration and tax identifications", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Identification type", "enum": [ "PASSPORT", "NATIONAL_ID", "DRIVERS_LICENSE", "SSN", "TAX_ID", "LEI", "EIN", "VAT_NUMBER", "BUSINESS_REGISTRATION", "OTHER" ] }, "number": { "type": "string", "description": "Identification number" }, "typeOther": { "type": "string", "description": "Custom type (if type is \"OTHER\")" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "associatedPersons": { "type": "array", "description": "Associated Person details (e.g. authorized signatory, beneficial owners). `enabled`, `verified` and `vasp` are always null on these entries.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the person" }, "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "type": { "type": "string", "description": "Always `INDIVIDUAL` for an associated person", "enum": [ "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Role this person holds in relation to the participant", "enum": [ "AUTHORIZED_SIGNATORY", "BENEFICIARY_OWNER", "INTERMEDIARY_BENEFICIARY_OWNER" ] }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "phoneNumber": { "type": "string", "description": "Contact phone" }, "website": { "type": "string", "description": "Website URL" }, "email": { "type": "string", "description": "Contact email" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "bankAccounts": { "type": "array", "description": "Bank accounts configured for fiat settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the bank account" }, "bankName": { "type": "string", "description": "Bank institution name" }, "bankBranchName": { "type": "string", "description": "Branch name" }, "accountNumber": { "type": "string", "description": "Bank account number" }, "accountAlias": { "type": "string", "description": "Friendly alias for the account" }, "accountName": { "type": "string", "description": "Account holder name" }, "currency": { "type": "string", "description": "Account currency (ISO 4217)" }, "iban": { "type": "string", "description": "International Bank Account Number" }, "swiftBic": { "type": "string", "description": "SWIFT/BIC code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "city": { "type": "string", "description": "Bank branch city" }, "street": { "type": "string", "description": "Bank branch street address" }, "postalCode": { "type": "string", "description": "Bank branch postal code" }, "memo": { "type": "string", "description": "Additional notes" }, "intermediaryBankCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the intermediary bank, where one is used" }, "intermediaryBankSwiftBic": { "type": "string", "description": "SWIFT/BIC code of the intermediary bank, where one is used" }, "enabled": { "type": "boolean", "description": "Whether account is enabled" }, "verified": { "type": "boolean", "description": "Whether account is verified" }, "networkIds": { "type": "array", "description": "Settlement networks this bank account may be used with", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "wallets": { "type": "array", "description": "Crypto wallet addresses for digital asset settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier" }, "blockchain": { "type": "string", "description": "Blockchain network (e.g., `Ethereum`, `Polygon`, `TRON`)" }, "asset": { "type": "string", "description": "Digital asset symbol (e.g., `USDC`, `USDT`, `BTC`)" }, "walletAddress": { "type": "string", "description": "Blockchain wallet address" }, "alias": { "type": "string", "description": "Friendly alias for the wallet" }, "type": { "type": "string", "description": "`SELF_HOSTED` or `CUSTODY`" }, "memo": { "type": "string", "description": "Additional notes" }, "vasp": { "type": "string", "description": "Virtual Asset Service Provider name (if custody)" }, "executionProvider": { "type": "string", "description": "Execution provider name (if applicable)" }, "default": { "type": "boolean", "description": "Whether this is the default wallet for the asset" }, "enabled": { "type": "boolean", "description": "Whether wallet is enabled for trading" }, "whitelisted": { "type": "boolean", "description": "Whether wallet address is whitelisted" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Beneficiary creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "total": { "type": "integer", "description": "Total Beneficiary records returned" } } }, { "title": "Beneficiary list — `type: INDIVIDUAL`", "type": "object", "properties": { "data": { "type": "array", "description": "Array of beneficiary objects", "items": { "type": "object", "properties": { "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the Beneficiary" }, "type": { "type": "string", "description": "Whether this participant is a legal entity or a natural person", "enum": [ "ENTITY", "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Always `BENEFICIARY`", "enum": [ "BENEFICIARY" ] }, "enabled": { "type": "boolean", "description": "Whether Beneficiary is enabled for trading" }, "verified": { "type": "boolean", "description": "Whether Beneficiary has completed verification" }, "vasp": { "type": "boolean", "description": "Virtual Asset Service Provider flag" }, "ownershipPercentage": { "type": "string", "description": "Percentage of the participant owned, for participants held as an ownership interest. Absent when not recorded." }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "clientAccountGroupName": { "type": "string", "description": "Account group (sub-account) name" }, "clientAccountGroupUuid": { "type": "string", "description": "Account group UUID" }, "email": { "type": "string", "description": "Beneficiary contact email" }, "phoneNumber": { "type": "string", "description": "Beneficiary contact phone" }, "website": { "type": "string", "description": "Beneficiary website URL" }, "address": { "type": "object", "description": "Beneficiary address details", "properties": { "street": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City" }, "stateProvince": { "type": "string", "description": "State or province" }, "postalCode": { "type": "string", "description": "Postal/ZIP code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "kycDetails": { "type": "object", "description": "KYC and compliance information", "properties": { "occupation": { "type": "string", "description": "Occupation or business activity" }, "sourceOfFunds": { "type": "string", "description": "Source of funds description" }, "methodOfVerification": { "type": "string", "description": "Verification method used" }, "industryType": { "type": "string", "description": "Industry classification" }, "entityType": { "type": "string", "description": "Legal entity type" }, "natureOfActivity": { "type": "string", "description": "Nature of business activity" }, "beneficiaryOwnership": { "type": "boolean", "description": "Beneficiary ownership flag" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "identifications": { "type": "array", "description": "Business registration and tax identifications", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Identification type", "enum": [ "PASSPORT", "NATIONAL_ID", "DRIVERS_LICENSE", "SSN", "TAX_ID", "LEI", "EIN", "VAT_NUMBER", "BUSINESS_REGISTRATION", "OTHER" ] }, "number": { "type": "string", "description": "Identification number" }, "typeOther": { "type": "string", "description": "Custom type (if type is \"OTHER\")" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "associatedPersons": { "type": "array", "description": "Associated Person details (e.g. authorized signatory, beneficial owners). `enabled`, `verified` and `vasp` are always null on these entries.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the person" }, "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "type": { "type": "string", "description": "Always `INDIVIDUAL` for an associated person", "enum": [ "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Role this person holds in relation to the participant", "enum": [ "AUTHORIZED_SIGNATORY", "BENEFICIARY_OWNER", "INTERMEDIARY_BENEFICIARY_OWNER" ] }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "phoneNumber": { "type": "string", "description": "Contact phone" }, "website": { "type": "string", "description": "Website URL" }, "email": { "type": "string", "description": "Contact email" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "bankAccounts": { "type": "array", "description": "Bank accounts configured for fiat settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the bank account" }, "bankName": { "type": "string", "description": "Bank institution name" }, "bankBranchName": { "type": "string", "description": "Branch name" }, "accountNumber": { "type": "string", "description": "Bank account number" }, "accountAlias": { "type": "string", "description": "Friendly alias for the account" }, "accountName": { "type": "string", "description": "Account holder name" }, "currency": { "type": "string", "description": "Account currency (ISO 4217)" }, "iban": { "type": "string", "description": "International Bank Account Number" }, "swiftBic": { "type": "string", "description": "SWIFT/BIC code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "city": { "type": "string", "description": "Bank branch city" }, "street": { "type": "string", "description": "Bank branch street address" }, "postalCode": { "type": "string", "description": "Bank branch postal code" }, "memo": { "type": "string", "description": "Additional notes" }, "intermediaryBankCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the intermediary bank, where one is used" }, "intermediaryBankSwiftBic": { "type": "string", "description": "SWIFT/BIC code of the intermediary bank, where one is used" }, "enabled": { "type": "boolean", "description": "Whether account is enabled" }, "verified": { "type": "boolean", "description": "Whether account is verified" }, "networkIds": { "type": "array", "description": "Settlement networks this bank account may be used with", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "wallets": { "type": "array", "description": "Crypto wallet addresses for digital asset settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier" }, "blockchain": { "type": "string", "description": "Blockchain network (e.g., `Ethereum`, `Polygon`, `TRON`)" }, "asset": { "type": "string", "description": "Digital asset symbol (e.g., `USDC`, `USDT`, `BTC`)" }, "walletAddress": { "type": "string", "description": "Blockchain wallet address" }, "alias": { "type": "string", "description": "Friendly alias for the wallet" }, "type": { "type": "string", "description": "`SELF_HOSTED` or `CUSTODY`" }, "memo": { "type": "string", "description": "Additional notes" }, "vasp": { "type": "string", "description": "Virtual Asset Service Provider name (if custody)" }, "executionProvider": { "type": "string", "description": "Execution provider name (if applicable)" }, "default": { "type": "boolean", "description": "Whether this is the default wallet for the asset" }, "enabled": { "type": "boolean", "description": "Whether wallet is enabled for trading" }, "whitelisted": { "type": "boolean", "description": "Whether wallet address is whitelisted" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Beneficiary creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "total": { "type": "integer", "description": "Total Beneficiary records returned" } } }, { "title": "Error — returned with HTTP 200", "type": "object", "description": "On a validation or authentication failure this endpoint renders an error body but does not set an error HTTP status: the response is still `200 OK` and the failure is reported only by `resultCode`. Clients must inspect `resultCode` rather than relying on the status code.", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Failure reason.", "enum": [ "INVALID_PARAMETERS", "UNAUTHORISED" ], "example": "INVALID_PARAMETERS" } } } ] } } } } }, "deprecated": false } }, "/api/3/senders": { "post": { "tags": [ "Payment participants" ], "summary": "Get Sender (Collection Accounts) List", "description": "Retrieve a list of third-party sender (collection) details configured for your account along with a list of their wallet addresses that they will deliver from. Senders are external entities that can send digital assets to Zodia Markets on your behalf. The contra-currency is then delivered to your named account.", "operationId": "get-sender-list", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "limit": 50, "offset": 0 }, "schema": { "type": "object", "required": [ "tonce" ], "properties": { "tonce": { "type": "integer", "description": "The current Unix time in microseconds.", "format": "int64" }, "nonce": { "type": "integer", "description": "Alternative to `tonce`. Every request must carry either `nonce` or `tonce`, and the value must parse as a whole number; a request with neither is rejected with `INVALID_NONCE_OR_TONCE`.", "format": "int64" }, "accountGroupUuid": { "type": "string", "description": "Filter senders by specific account group UUID" }, "limit": { "type": "integer", "description": "Maximum results to return. Validation caps this at 50 — a larger value is rejected with `INVALID_PARAMETERS`. When omitted, the participants service applies its own default.", "format": "int32", "minimum": 0, "maximum": 50 }, "offset": { "type": "integer", "description": "Offset for pagination", "format": "int32" }, "userUuid": { "type": "string", "description": "Master API keys only: UUID of the user to act on behalf of. Ignored unless the calling key belongs to the owner of a master-API-enabled site." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": [ { "companyName": "MY TEST SENDER", "dateOfFormation": "2026-03-04", "countryOfFormation": "RS", "countryOfRegistration": "RS", "uuid": "adece4a5-52eb-4858-93ad-1c7ce3271c0c", "clientShortcode": "USDTTEST1", "clientAccountGroupName": "Default", "clientAccountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "type": "ENTITY", "kind": "SENDER", "phoneNumber": "", "website": "www.po123411.com", "email": "mytestsender@po.xyz", "vasp": true, "enabled": true, "verified": true, "address": { "country": "GB", "city": "London", "street": "200 Twenty Street", "postalCode": "N99 2LA", "stateProvince": "London", "createdAt": "2026-05-07T16:47:25Z", "updatedAt": "2026-05-07T16:47:25Z" }, "kycDetails": { "occupation": "Service Provider", "sourceOfFunds": "Trading", "methodOfVerification": "Electronic", "industryType": "Technology", "entityType": "NA", "natureOfActivity": "Payment Service Provider", "beneficiaryOwnership": false, "createdAt": "2026-05-07T16:47:24Z", "updatedAt": "2026-05-07T16:47:24Z" }, "associatedPersons": [ { "firstname": "Paul", "lastname": "Spaul", "dateOfBirth": "2017-01-31", "countryOfOrigin": "AR", "nationality": "AR", "uuid": "bcaaf5aa-373e-496e-bc49-d35f0735edbe", "clientShortcode": "USDTTEST1", "type": "INDIVIDUAL", "kind": "AUTHORIZED_SIGNATORY", "phoneNumber": "", "website": "", "email": "", "createdAt": "2026-05-07T16:47:20Z", "updatedAt": "2026-05-07T16:47:20Z" } ], "identifications": [ { "type": "OTHER", "number": "MB109871", "typeOther": "MSB", "createdAt": "2026-05-07T16:47:21Z", "updatedAt": "2026-05-07T16:47:21Z" }, { "type": "BUSINESS_REGISTRATION", "number": "100099887762", "typeOther": "", "createdAt": "2026-05-07T16:47:23Z", "updatedAt": "2026-05-07T16:47:23Z" } ], "bankAccounts": [], "wallets": [ { "uuid": "c7f3d22f-d70a-4e08-9aeb-46187603ecba", "blockchain": "Ethereum", "asset": "USDC", "walletAddress": "0x9023092829822", "alias": "USDC_SENDER_USDTTEST1", "type": "SELF_HOSTED", "memo": "MY USDC WALLET", "vasp": "", "executionProvider": "", "default": true, "enabled": true, "whitelisted": true, "createdAt": "2026-04-16T15:49:19Z", "updatedAt": "2026-04-16T15:49:19Z" }, { "uuid": "37f58a57-2795-4280-979b-960984d6759f", "blockchain": "TRON", "asset": "USDT", "walletAddress": "0x98289282827272", "alias": "USDT_WALLET_USDTTEST1_SENDER", "type": "SELF_HOSTED", "memo": "", "vasp": "", "executionProvider": "", "default": true, "enabled": true, "whitelisted": true, "createdAt": "2026-03-25T14:15:19Z", "updatedAt": "2026-03-25T14:15:19Z" } ], "createdAt": "2026-05-07T16:47:27Z", "updatedAt": "2026-05-07T16:47:27Z" } ], "total": 1 } } }, "schema": { "oneOf": [ { "title": "Sender list — `type: ENTITY`", "type": "object", "properties": { "data": { "type": "array", "description": "Array of sender objects", "items": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Sender company/entity name" }, "companyName2": { "type": "string", "description": "Second line of the registered name, where the name needs one" }, "dateOfFormation": { "type": "string", "format": "date", "description": "Sender Company formation date (YYYY-MM-DD)" }, "countryOfFormation": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "countryOfRegistration": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the Sender" }, "type": { "type": "string", "description": "Whether this participant is a legal entity or a natural person", "enum": [ "ENTITY", "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Always `SENDER`", "enum": [ "SENDER" ] }, "enabled": { "type": "boolean", "description": "Whether Sender is enabled for trading" }, "verified": { "type": "boolean", "description": "Whether Sender has completed verification" }, "vasp": { "type": "boolean", "description": "Virtual Asset Service Provider flag" }, "ownershipPercentage": { "type": "string", "description": "Percentage of the participant owned, for participants held as an ownership interest. Absent when not recorded." }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "clientAccountGroupName": { "type": "string", "description": "Account group (sub-account) name" }, "clientAccountGroupUuid": { "type": "string", "description": "Account group UUID" }, "email": { "type": "string", "description": "Sender contact email" }, "phoneNumber": { "type": "string", "description": "Sender contact phone" }, "website": { "type": "string", "description": "Sender website URL" }, "address": { "type": "object", "description": "Sender address details", "properties": { "street": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City" }, "stateProvince": { "type": "string", "description": "State or province" }, "postalCode": { "type": "string", "description": "Postal/ZIP code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "kycDetails": { "type": "object", "description": "KYC and compliance information", "properties": { "occupation": { "type": "string", "description": "Occupation or business activity" }, "sourceOfFunds": { "type": "string", "description": "Source of funds description" }, "methodOfVerification": { "type": "string", "description": "Verification method used" }, "industryType": { "type": "string", "description": "Industry classification" }, "entityType": { "type": "string", "description": "Legal entity type" }, "natureOfActivity": { "type": "string", "description": "Nature of business activity" }, "beneficiaryOwnership": { "type": "boolean", "description": "Beneficiary ownership flag" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "identifications": { "type": "array", "description": "Business registration and tax identifications", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Identification type", "enum": [ "PASSPORT", "NATIONAL_ID", "DRIVERS_LICENSE", "SSN", "TAX_ID", "LEI", "EIN", "VAT_NUMBER", "BUSINESS_REGISTRATION", "OTHER" ] }, "number": { "type": "string", "description": "Identification number" }, "typeOther": { "type": "string", "description": "Custom type (if type is \"OTHER\")" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "associatedPersons": { "type": "array", "description": "Associated Person details (e.g. authorized signatory, beneficial owners). `enabled`, `verified` and `vasp` are always null on these entries.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the person" }, "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "type": { "type": "string", "description": "Always `INDIVIDUAL` for an associated person", "enum": [ "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Role this person holds in relation to the participant", "enum": [ "AUTHORIZED_SIGNATORY", "BENEFICIARY_OWNER", "INTERMEDIARY_BENEFICIARY_OWNER" ] }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "phoneNumber": { "type": "string", "description": "Contact phone" }, "website": { "type": "string", "description": "Website URL" }, "email": { "type": "string", "description": "Contact email" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "bankAccounts": { "type": "array", "description": "Bank accounts configured for fiat settlement (not currently supported)", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the bank account" }, "bankName": { "type": "string", "description": "Bank institution name" }, "bankBranchName": { "type": "string", "description": "Branch name" }, "accountNumber": { "type": "string", "description": "Bank account number" }, "accountAlias": { "type": "string", "description": "Friendly alias for the account" }, "accountName": { "type": "string", "description": "Account holder name" }, "currency": { "type": "string", "description": "Account currency (ISO 4217)" }, "iban": { "type": "string", "description": "International Bank Account Number" }, "swiftBic": { "type": "string", "description": "SWIFT/BIC code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "city": { "type": "string", "description": "Bank branch city" }, "street": { "type": "string", "description": "Bank branch street address" }, "postalCode": { "type": "string", "description": "Bank branch postal code" }, "memo": { "type": "string", "description": "Additional notes" }, "intermediaryBankCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the intermediary bank, where one is used" }, "intermediaryBankSwiftBic": { "type": "string", "description": "SWIFT/BIC code of the intermediary bank, where one is used" }, "enabled": { "type": "boolean", "description": "Whether account is enabled" }, "verified": { "type": "boolean", "description": "Whether account is verified" }, "networkIds": { "type": "array", "description": "Settlement networks this bank account may be used with", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "wallets": { "type": "array", "description": "Crypto wallet addresses the Sender will send funds from for digital asset settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier" }, "blockchain": { "type": "string", "description": "Blockchain network (e.g., `Ethereum`, `Polygon`, `TRON`)" }, "asset": { "type": "string", "description": "Digital asset symbol (e.g., `USDC`, `USDT`, `BTC`)" }, "walletAddress": { "type": "string", "description": "Blockchain wallet address" }, "alias": { "type": "string", "description": "Friendly alias for the wallet" }, "type": { "type": "string", "description": "`SELF_HOSTED` or `CUSTODY`" }, "memo": { "type": "string", "description": "Additional notes" }, "vasp": { "type": "string", "description": "Virtual Asset Service Provider name (if custody)" }, "executionProvider": { "type": "string", "description": "Execution provider name (if applicable)" }, "default": { "type": "boolean", "description": "Whether this is the default wallet for the asset" }, "enabled": { "type": "boolean", "description": "Whether wallet is enabled for trading" }, "whitelisted": { "type": "boolean", "description": "Whether wallet address is whitelisted" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Sender creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "total": { "type": "integer", "description": "Total Sender records returned" } } }, { "title": "Sender list — `type: INDIVIDUAL`", "type": "object", "properties": { "data": { "type": "array", "description": "Array of sender objects", "items": { "type": "object", "properties": { "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the Sender" }, "type": { "type": "string", "description": "Whether this participant is a legal entity or a natural person", "enum": [ "ENTITY", "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Always `SENDER`", "enum": [ "SENDER" ] }, "enabled": { "type": "boolean", "description": "Whether Sender is enabled for trading" }, "verified": { "type": "boolean", "description": "Whether Sender has completed verification" }, "vasp": { "type": "boolean", "description": "Virtual Asset Service Provider flag" }, "ownershipPercentage": { "type": "string", "description": "Percentage of the participant owned, for participants held as an ownership interest. Absent when not recorded." }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "clientAccountGroupName": { "type": "string", "description": "Account group (sub-account) name" }, "clientAccountGroupUuid": { "type": "string", "description": "Account group UUID" }, "email": { "type": "string", "description": "Sender contact email" }, "phoneNumber": { "type": "string", "description": "Sender contact phone" }, "website": { "type": "string", "description": "Sender website URL" }, "address": { "type": "object", "description": "Sender address details", "properties": { "street": { "type": "string", "description": "Street address" }, "city": { "type": "string", "description": "City" }, "stateProvince": { "type": "string", "description": "State or province" }, "postalCode": { "type": "string", "description": "Postal/ZIP code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "kycDetails": { "type": "object", "description": "KYC and compliance information", "properties": { "occupation": { "type": "string", "description": "Occupation or business activity" }, "sourceOfFunds": { "type": "string", "description": "Source of funds description" }, "methodOfVerification": { "type": "string", "description": "Verification method used" }, "industryType": { "type": "string", "description": "Industry classification" }, "entityType": { "type": "string", "description": "Legal entity type" }, "natureOfActivity": { "type": "string", "description": "Nature of business activity" }, "beneficiaryOwnership": { "type": "boolean", "description": "Beneficiary ownership flag" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } }, "identifications": { "type": "array", "description": "Business registration and tax identifications", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Identification type", "enum": [ "PASSPORT", "NATIONAL_ID", "DRIVERS_LICENSE", "SSN", "TAX_ID", "LEI", "EIN", "VAT_NUMBER", "BUSINESS_REGISTRATION", "OTHER" ] }, "number": { "type": "string", "description": "Identification number" }, "typeOther": { "type": "string", "description": "Custom type (if type is \"OTHER\")" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "associatedPersons": { "type": "array", "description": "Associated Person details (e.g. authorized signatory, beneficial owners). `enabled`, `verified` and `vasp` are always null on these entries.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the person" }, "firstname": { "type": "string", "description": "Given name" }, "lastname": { "type": "string", "description": "Family name" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth (YYYY-MM-DD)" }, "countryOfOrigin": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of origin" }, "nationality": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of nationality" }, "type": { "type": "string", "description": "Always `INDIVIDUAL` for an associated person", "enum": [ "INDIVIDUAL" ] }, "kind": { "type": "string", "description": "Role this person holds in relation to the participant", "enum": [ "AUTHORIZED_SIGNATORY", "BENEFICIARY_OWNER", "INTERMEDIARY_BENEFICIARY_OWNER" ] }, "clientShortcode": { "type": "string", "description": "Your account identifier" }, "phoneNumber": { "type": "string", "description": "Contact phone" }, "website": { "type": "string", "description": "Website URL" }, "email": { "type": "string", "description": "Contact email" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "bankAccounts": { "type": "array", "description": "Bank accounts configured for fiat settlement (not currently supported)", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the bank account" }, "bankName": { "type": "string", "description": "Bank institution name" }, "bankBranchName": { "type": "string", "description": "Branch name" }, "accountNumber": { "type": "string", "description": "Bank account number" }, "accountAlias": { "type": "string", "description": "Friendly alias for the account" }, "accountName": { "type": "string", "description": "Account holder name" }, "currency": { "type": "string", "description": "Account currency (ISO 4217)" }, "iban": { "type": "string", "description": "International Bank Account Number" }, "swiftBic": { "type": "string", "description": "SWIFT/BIC code" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code" }, "city": { "type": "string", "description": "Bank branch city" }, "street": { "type": "string", "description": "Bank branch street address" }, "postalCode": { "type": "string", "description": "Bank branch postal code" }, "memo": { "type": "string", "description": "Additional notes" }, "intermediaryBankCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the intermediary bank, where one is used" }, "intermediaryBankSwiftBic": { "type": "string", "description": "SWIFT/BIC code of the intermediary bank, where one is used" }, "enabled": { "type": "boolean", "description": "Whether account is enabled" }, "verified": { "type": "boolean", "description": "Whether account is verified" }, "networkIds": { "type": "array", "description": "Settlement networks this bank account may be used with", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "wallets": { "type": "array", "description": "Crypto wallet addresses the Sender will send funds from for digital asset settlement", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier" }, "blockchain": { "type": "string", "description": "Blockchain network (e.g., `Ethereum`, `Polygon`, `TRON`)" }, "asset": { "type": "string", "description": "Digital asset symbol (e.g., `USDC`, `USDT`, `BTC`)" }, "walletAddress": { "type": "string", "description": "Blockchain wallet address" }, "alias": { "type": "string", "description": "Friendly alias for the wallet" }, "type": { "type": "string", "description": "`SELF_HOSTED` or `CUSTODY`" }, "memo": { "type": "string", "description": "Additional notes" }, "vasp": { "type": "string", "description": "Virtual Asset Service Provider name (if custody)" }, "executionProvider": { "type": "string", "description": "Execution provider name (if applicable)" }, "default": { "type": "boolean", "description": "Whether this is the default wallet for the asset" }, "enabled": { "type": "boolean", "description": "Whether wallet is enabled for trading" }, "whitelisted": { "type": "boolean", "description": "Whether wallet address is whitelisted" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "createdAt": { "type": "string", "format": "date-time", "description": "Sender creation timestamp (ISO 8601)" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last update timestamp (ISO 8601)" } } } }, "total": { "type": "integer", "description": "Total Sender records returned" } } }, { "title": "Error — returned with HTTP 200", "type": "object", "description": "On a validation or authentication failure this endpoint renders an error body but does not set an error HTTP status: the response is still `200 OK` and the failure is reported only by `resultCode`. Clients must inspect `resultCode` rather than relying on the status code.", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp of the response (milliseconds).", "example": "1770888183656" }, "resultCode": { "type": "string", "description": "Failure reason.", "enum": [ "INVALID_PARAMETERS", "UNAUTHORISED" ], "example": "INVALID_PARAMETERS" } } } ] } } } } }, "deprecated": false } }, "/api/3/withdrawal/fiat": { "post": { "tags": [ "Withdrawals" ], "summary": "Submit Fiat Withdrawal Request", "description": "Raise a request to withdraw fiat to a bank account already registered against your onboarded entity. The request enters an approval queue and **moves no funds**: money leaves only once Zodia Markets Operations has approved and processed it. Until then the request is visible on the list endpoint and can be cancelled.", "operationId": "submit-fiat-withdrawal", "x-note": "**This call is not idempotent and there is no idempotency key.** A retry does not resolve to the same request: replaying the original body is refused by the anti-replay check, and resending with a fresh `nonce` or `tonce` creates a **second withdrawal request**. If a submit times out or returns `500`, do not retry blind - call the matching list endpoint first to establish whether the request was created, and resubmit only if it was not.", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "ccy": "USD", "amount": 2500, "withdrawalMethod": "BANK_WIRE", "bankAccountUuid": "7f3a9c21-4d5e-6f70-8192-a3b4c5d6e7f8", "clientComment": "Monthly settlement" }, "schema": { "type": "object", "required": [ "tonce", "accountGroupUuid", "ccy", "amount", "withdrawalMethod", "bankAccountUuid" ], "properties": { "tonce": { "type": "integer", "format": "int64", "description": "The current Unix time in microseconds. Accepted only within two minutes of server time. Send either `tonce` or `nonce`." }, "nonce": { "type": "integer", "format": "int64", "description": "Alternative to `tonce`, and takes precedence when both are sent. Must be a whole number and **strictly increasing** for a given API key: a reused or lower value is rejected. A request carrying neither `nonce` nor `tonce` is rejected with `401`." }, "accountGroupUuid": { "type": "string", "description": "The account group to withdraw from. You must hold `ROLE_OPERATIONS` on it." }, "ccy": { "type": "string", "description": "Currency code, e.g. `USD`. Must be a currency the platform supports." }, "amount": { "type": "number", "format": "double", "description": "Amount to withdraw. Must be positive and carry **at most two decimal places**; a third is rejected." }, "withdrawalMethod": { "type": "string", "enum": [ "BANK_WIRE" ], "description": "`BANK_WIRE` is the only accepted value." }, "bankAccountUuid": { "type": "string", "description": "A bank account registered against your onboarded entity for this account group. It must be enabled and verified, and its currency must equal `ccy`. Register it before withdrawing; it cannot be created as part of this call. See [Get Account Details List](/reference/get-account-details-list)." }, "clientComment": { "type": "string", "maxLength": 1024, "description": "Free text, up to 1024 characters. Echoed back on the list endpoints." } } } } } }, "responses": { "200": { "description": "Request accepted into the approval queue. No funds have moved.", "content": { "application/json": { "example": { "success": true, "uuid": "e1b2c3d4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "uuid": { "type": "string", "example": "e1b2c3d4-5a6b-7c8d-9e0f-1a2b3c4d5e6f", "description": "Identifier of the new fiat withdrawal request. Pass it to the cancel endpoint, and match it against the list endpoint. The request starts in `PENDING_APPROVAL`." } } } } } }, "401": { "description": "Authentication failed: unknown key, bad signature, a missing, malformed, reused or decreasing `nonce` or out-of-window `tonce`, a body that is not parseable JSON, or a throttled caller. Rate limiting surfaces here as `401`, not `429`.", "content": { "application/json": { "example": { "success": false, "message": "Unauthorized" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized" } } } } } }, "403": { "description": "Body missing or failed field validation (`Invalid signed params`), the API key lacks the Move Funds permission (`MOVE FUNDS permission required`), or you do not hold `ROLE_OPERATIONS` on `accountGroupUuid` (`You do not have permission to perform this action`). The message does not name the field or the permission at fault.", "content": { "application/json": { "example": { "success": false, "message": "Invalid signed params" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid signed params" } } } } } }, "422": { "description": "Business validation failed. The request was not created.\n\n| `message` | Cause |\n|---|---|\n| `Bank account not found in account group` | `bankAccountUuid` is not a bank account on your onboarded entity for this account group |\n| `Bank account is disabled or is not verified` | The account exists but is not usable |\n| `Bank account does not support the requested currency` | The account's currency is not `ccy` |\n| `Insufficient funds` | `amount` exceeds your total balance on that currency less the requests already in flight |", "content": { "application/json": { "example": { "success": false, "message": "Insufficient funds" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Insufficient funds" } } } } } }, "500": { "description": "Unexpected error. The outcome is undefined - for a submit, use the list endpoint to establish whether the request was created before resending.", "content": { "application/json": { "example": { "success": false, "message": "Error while processing request" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Error while processing request" } } } } } } }, "deprecated": false } }, "/api/3/withdrawal/crypto": { "post": { "tags": [ "Withdrawals" ], "summary": "Submit Crypto Withdrawal Request", "description": "Raise a request to withdraw a digital asset to a wallet already whitelisted against your onboarded entity. The request enters an approval queue and **moves no funds**: the transfer happens only once Zodia Markets Operations has approved and processed it. Until then the request is visible on the list endpoint and can be cancelled.", "operationId": "submit-crypto-withdrawal", "x-note": "**This call is not idempotent and there is no idempotency key.** A retry does not resolve to the same request: replaying the original body is refused by the anti-replay check, and resending with a fresh `nonce` or `tonce` creates a **second withdrawal request**. If a submit times out or returns `500`, do not retry blind - call the matching list endpoint first to establish whether the request was created, and resubmit only if it was not.", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8", "ccy": "BTC", "amount": 0.75, "walletParticipantUuid": "5fff78ca-d87f-424f-90bf-96b1906a284b", "clientComment": "Treasury sweep" }, "schema": { "type": "object", "required": [ "tonce", "accountGroupUuid", "ccy", "amount", "walletParticipantUuid" ], "properties": { "tonce": { "type": "integer", "format": "int64", "description": "The current Unix time in microseconds. Accepted only within two minutes of server time. Send either `tonce` or `nonce`." }, "nonce": { "type": "integer", "format": "int64", "description": "Alternative to `tonce`, and takes precedence when both are sent. Must be a whole number and **strictly increasing** for a given API key: a reused or lower value is rejected. A request carrying neither `nonce` nor `tonce` is rejected with `401`." }, "accountGroupUuid": { "type": "string", "description": "The account group to withdraw from. You must hold `ROLE_OPERATIONS` on it." }, "ccy": { "type": "string", "description": "Asset code, e.g. `BTC`. Must be an asset the platform supports." }, "amount": { "type": "number", "format": "double", "description": "Amount to withdraw. Must be positive. There is no two-decimal-place cap as there is on fiat, but the platform stores the amount to **8 decimal places**, so do not send more." }, "walletParticipantUuid": { "type": "string", "description": "A wallet registered against your onboarded entity for this account group. It must be enabled and whitelisted, and its asset must equal `ccy`. Register it before withdrawing; it cannot be created as part of this call. See [Get Account Details List](/reference/get-account-details-list)." }, "clientComment": { "type": "string", "maxLength": 1024, "description": "Free text, up to 1024 characters. Echoed back on the list endpoints." } } } } } }, "responses": { "200": { "description": "Request accepted into the approval queue. No funds have moved.", "content": { "application/json": { "example": { "success": true, "uuid": "e1b2c3d4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "uuid": { "type": "string", "example": "e1b2c3d4-5a6b-7c8d-9e0f-1a2b3c4d5e6f", "description": "Identifier of the new crypto withdrawal request. Pass it to the cancel endpoint, and match it against the list endpoint. The request starts in `PENDING_APPROVAL`." } } } } } }, "401": { "description": "Authentication failed: unknown key, bad signature, a missing, malformed, reused or decreasing `nonce` or out-of-window `tonce`, a body that is not parseable JSON, or a throttled caller. Rate limiting surfaces here as `401`, not `429`.", "content": { "application/json": { "example": { "success": false, "message": "Unauthorized" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized" } } } } } }, "403": { "description": "Body missing or failed field validation (`Invalid signed params`), the API key lacks the Move Funds permission (`MOVE FUNDS permission required`), or you do not hold `ROLE_OPERATIONS` on `accountGroupUuid` (`You do not have permission to perform this action`). The message does not name the field or the permission at fault.", "content": { "application/json": { "example": { "success": false, "message": "Invalid signed params" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid signed params" } } } } } }, "422": { "description": "Business validation failed. The request was not created.\n\n| `message` | Cause |\n|---|---|\n| `Wallet not found for the caller's accountGroup` | `walletParticipantUuid` is not a wallet on your onboarded entity for this account group |\n| `Wallet is disabled or is not whitelisted` | The wallet exists but is not usable |\n| `Wallet does not support the requested currency` | The wallet's asset is not `ccy` |\n| `Insufficient funds` | `amount` exceeds your total balance on that asset less the requests already in flight |", "content": { "application/json": { "example": { "success": false, "message": "Insufficient funds" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Insufficient funds" } } } } } }, "500": { "description": "Unexpected error. The outcome is undefined - for a submit, use the list endpoint to establish whether the request was created before resending.", "content": { "application/json": { "example": { "success": false, "message": "Error while processing request" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Error while processing request" } } } } } } }, "deprecated": false } }, "/api/3/withdrawal/fiat/list": { "post": { "tags": [ "Withdrawals" ], "summary": "List Fiat Withdrawal Requests", "description": "Every **client-initiated** fiat withdrawal request on every account group where you hold `ROLE_OPERATIONS`, newest first. Requests raised by Zodia Markets Operations on your behalf are not returned. This is a `POST` because the anti-replay element travels in the signed body.", "operationId": "list-fiat-withdrawals", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000 }, "schema": { "type": "object", "required": [ "tonce" ], "description": "Carries the anti-replay element and nothing else. There is no account-group parameter, and an `accountGroupUuid` sent here is **ignored**: the response always spans every account group on which you hold `ROLE_OPERATIONS`.", "properties": { "tonce": { "type": "integer", "format": "int64", "description": "The current Unix time in microseconds. Accepted only within two minutes of server time. Send either `tonce` or `nonce`." }, "nonce": { "type": "integer", "format": "int64", "description": "Alternative to `tonce`, and takes precedence when both are sent. Must be a whole number and **strictly increasing** for a given API key: a reused or lower value is rejected. A request carrying neither `nonce` nor `tonce` is rejected with `401`." } } } } } }, "responses": { "200": { "description": "Every fiat withdrawal request you can see, newest first by creation date. No pagination and no filtering, so page and filter client-side.", "content": { "application/json": { "schema": { "type": "array", "description": "A JSON array, not an object. Empty when you hold `ROLE_OPERATIONS` on no account group, so an empty array is not proof that you have raised no withdrawal requests.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Pass this to the cancel endpoint." }, "amount": { "type": "string", "description": "Exact decimal as a string, never a float. Parse it as a decimal." }, "ccy": { "type": "string", "description": "Currency or asset code." }, "state": { "type": "string", "enum": [ "PENDING_APPROVAL", "PENDING", "PROCESSED", "CANCELLED" ], "description": "`PENDING_APPROVAL` awaiting review by Zodia Markets Operations, and the only state a request can be cancelled from. `PENDING` accepted by Operations and in progress. `PROCESSED` funds sent. `CANCELLED` cancelled by you **or** declined by Operations - the two are not distinguished. There is no `FAILED` on fiat. Every request raised through this API carries a `state`; as with any field, treat an absent one as unknown rather than as a value." }, "accountGroup": { "type": "string", "deprecated": true, "description": "Duplicate of `accountGroupName`, carrying exactly the same value. Read `accountGroupName` instead." }, "accountGroupUuid": { "type": "string", "description": "UUID of the account group the request belongs to." }, "accountGroupOwner": { "type": "string", "description": "Username of the account group's owner." }, "accountGroupOwnerUuid": { "type": "string", "description": "UUID of the account group's owner." }, "accountGroupName": { "type": "string", "description": "Name of the account group the request belongs to." }, "clientName": { "type": "string", "description": "The client the request belongs to. For a subordinate user this is the parent, not the submitter." }, "requestor": { "type": "string", "description": "The user who actually submitted the request, which need not be you." }, "withdrawalMethod": { "type": "string", "enum": [ "BANK_WIRE" ], "description": "Always `BANK_WIRE`." }, "beneficiary": { "type": "object", "description": "Your own onboarded entity, as registered with Zodia Markets.", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" } } }, "bankAccount": { "type": "object", "description": "The beneficiary bank account the funds are destined for.", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "alias": { "type": "string" } } }, "clientComment": { "type": "string", "description": "As submitted, up to 1024 characters. Absent when none was sent." }, "dateCreated": { "type": "string", "description": "When the request was raised. ISO-8601 with milliseconds and a zone offset, e.g. `2026-08-04T10:15:30.451+01:00`." }, "lastUpdated": { "type": "string", "description": "Changes on every state transition. Same format as `dateCreated`." } } } } } } }, "401": { "description": "Authentication failed: unknown key, bad signature, a missing, malformed, reused or decreasing `nonce` or out-of-window `tonce`, a body that is not parseable JSON, or a throttled caller. Rate limiting surfaces here as `401`, not `429`.", "content": { "application/json": { "example": { "success": false, "message": "Unauthorized" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized" } } } } } }, "403": { "description": "Body missing or malformed (`Invalid signed params`), or the API key lacks the Move Funds permission (`MOVE FUNDS permission required`), which these read-only endpoints require too.", "content": { "application/json": { "example": { "success": false, "message": "MOVE FUNDS permission required" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "MOVE FUNDS permission required" } } } } } }, "500": { "description": "Unexpected error. The outcome is undefined - for a submit, use the list endpoint to establish whether the request was created before resending.", "content": { "application/json": { "example": { "success": false, "message": "Error while processing request" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Error while processing request" } } } } } } }, "deprecated": false } }, "/api/3/withdrawal/crypto/list": { "post": { "tags": [ "Withdrawals" ], "summary": "List Crypto Withdrawal Requests", "description": "Every **client-initiated** crypto withdrawal request on every account group where you hold `ROLE_OPERATIONS`, newest first. Requests raised by Zodia Markets Operations on your behalf are not returned. This is a `POST` because the anti-replay element travels in the signed body.", "operationId": "list-crypto-withdrawals", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000 }, "schema": { "type": "object", "required": [ "tonce" ], "description": "Carries the anti-replay element and nothing else. There is no account-group parameter, and an `accountGroupUuid` sent here is **ignored**: the response always spans every account group on which you hold `ROLE_OPERATIONS`.", "properties": { "tonce": { "type": "integer", "format": "int64", "description": "The current Unix time in microseconds. Accepted only within two minutes of server time. Send either `tonce` or `nonce`." }, "nonce": { "type": "integer", "format": "int64", "description": "Alternative to `tonce`, and takes precedence when both are sent. Must be a whole number and **strictly increasing** for a given API key: a reused or lower value is rejected. A request carrying neither `nonce` nor `tonce` is rejected with `401`." } } } } } }, "responses": { "200": { "description": "Every crypto withdrawal request you can see, newest first by creation date. No pagination and no filtering, so page and filter client-side.", "content": { "application/json": { "schema": { "type": "array", "description": "A JSON array, not an object. Empty when you hold `ROLE_OPERATIONS` on no account group, so an empty array is not proof that you have raised no withdrawal requests.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Pass this to the cancel endpoint." }, "amount": { "type": "string", "description": "Exact decimal as a string, never a float. Parse it as a decimal." }, "ccy": { "type": "string", "description": "Currency or asset code." }, "coinAddress": { "type": "string", "description": "The destination address, copied from the whitelisted wallet at submit time." }, "state": { "type": "string", "enum": [ "PENDING_APPROVAL", "PENDING", "PROCESSED", "FAILED", "CANCELLED" ], "description": "`PENDING_APPROVAL` awaiting acceptance by Zodia Markets Operations, and the only state a request can be cancelled from. `PENDING` accepted by Operations and in progress. `PROCESSED` funds sent. `FAILED` is part of this vocabulary but no current processing flow produces it; tolerate it rather than expect it, and contact your relationship manager if you see it. `CANCELLED` cancelled by you **or** declined by Operations - the two are not distinguished. This vocabulary is derived differently from the fiat one and is a superset of it." }, "accountGroup": { "type": "string", "deprecated": true, "description": "Duplicate of `accountGroupName`, carrying exactly the same value. Read `accountGroupName` instead." }, "accountGroupUuid": { "type": "string", "description": "UUID of the account group the request belongs to." }, "accountGroupOwner": { "type": "string", "description": "Username of the account group's owner." }, "accountGroupOwnerUuid": { "type": "string", "description": "UUID of the account group's owner." }, "accountGroupName": { "type": "string", "description": "Name of the account group the request belongs to." }, "clientName": { "type": "string", "description": "The client the request belongs to. For a subordinate user this is the parent, not the submitter." }, "requestor": { "type": "string", "description": "The user who actually submitted the request, which need not be you." }, "beneficiary": { "type": "object", "description": "Your own onboarded entity, as registered with Zodia Markets.", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" } } }, "wallet": { "type": "object", "description": "The whitelisted wallet the funds are destined for.", "properties": { "uuid": { "type": "string" }, "address": { "type": "string" }, "alias": { "type": "string" } } }, "clientComment": { "type": "string", "description": "As submitted, up to 1024 characters. Absent when none was sent." }, "dateCreated": { "type": "string", "description": "When the request was raised. ISO-8601 with milliseconds and a zone offset, e.g. `2026-08-04T10:15:30.451+01:00`." }, "lastUpdated": { "type": "string", "description": "Changes on every state transition. Same format as `dateCreated`." } } } } } } }, "401": { "description": "Authentication failed: unknown key, bad signature, a missing, malformed, reused or decreasing `nonce` or out-of-window `tonce`, a body that is not parseable JSON, or a throttled caller. Rate limiting surfaces here as `401`, not `429`.", "content": { "application/json": { "example": { "success": false, "message": "Unauthorized" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized" } } } } } }, "403": { "description": "Body missing or malformed (`Invalid signed params`), or the API key lacks the Move Funds permission (`MOVE FUNDS permission required`), which these read-only endpoints require too.", "content": { "application/json": { "example": { "success": false, "message": "MOVE FUNDS permission required" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "MOVE FUNDS permission required" } } } } } }, "500": { "description": "Unexpected error. The outcome is undefined - for a submit, use the list endpoint to establish whether the request was created before resending.", "content": { "application/json": { "example": { "success": false, "message": "Error while processing request" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Error while processing request" } } } } } } }, "deprecated": false } }, "/api/3/withdrawal/fiat/{uuid}/cancel": { "post": { "tags": [ "Withdrawals" ], "summary": "Cancel Fiat Withdrawal Request", "description": "Withdraw a fiat request from the approval queue while it is still awaiting review. Possible only from `PENDING_APPROVAL`; once Operations has approved the request it is in flight and the call returns `409` with the state unchanged.", "operationId": "cancel-fiat-withdrawal", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The withdrawal request's `uuid`, as returned by the submit call or the matching list endpoint." } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8" }, "schema": { "type": "object", "required": [ "tonce", "accountGroupUuid" ], "properties": { "tonce": { "type": "integer", "format": "int64", "description": "The current Unix time in microseconds. Accepted only within two minutes of server time. Send either `tonce` or `nonce`." }, "nonce": { "type": "integer", "format": "int64", "description": "Alternative to `tonce`, and takes precedence when both are sent. Must be a whole number and **strictly increasing** for a given API key: a reused or lower value is rejected. A request carrying neither `nonce` nor `tonce` is rejected with `401`." }, "accountGroupUuid": { "type": "string", "description": "The account group the request belongs to. **Goes in the body, not the query string** - the signature covers the path and the body only, so a value on the URL would be unsigned and is not read. Sending `?accountGroupUuid=...` and omitting it from the body returns `403 Invalid signed params`." } } } } } }, "responses": { "200": { "description": "Cancelled. The request now reports `CANCELLED`.", "content": { "application/json": { "example": { "success": true, "uuid": "e1b2c3d4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "uuid": { "type": "string", "example": "e1b2c3d4-5a6b-7c8d-9e0f-1a2b3c4d5e6f", "description": "The cancelled request's identifier." } } } } } }, "401": { "description": "Authentication failed: unknown key, bad signature, a missing, malformed, reused or decreasing `nonce` or out-of-window `tonce`, a body that is not parseable JSON, or a throttled caller. Rate limiting surfaces here as `401`, not `429`.", "content": { "application/json": { "example": { "success": false, "message": "Unauthorized" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized" } } } } } }, "403": { "description": "`accountGroupUuid` missing or blank in the body (`Invalid signed params`), the API key lacks the Move Funds permission (`MOVE FUNDS permission required`), or you do not hold `ROLE_OPERATIONS` on that account group (`You do not have permission to perform this action`).", "content": { "application/json": { "example": { "success": false, "message": "Invalid signed params" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid signed params" } } } } } }, "404": { "description": "No withdrawal request with that `uuid` exists in that account group.", "content": { "application/json": { "example": { "success": false, "message": "Request not found" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Request not found" } } } } } }, "409": { "description": "The request is no longer in `PENDING_APPROVAL`. Its state is unchanged.", "content": { "application/json": { "example": { "success": false, "message": "Request can not be cancelled in current state" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Request can not be cancelled in current state" } } } } } }, "500": { "description": "Unexpected error. The outcome is undefined - for a submit, use the list endpoint to establish whether the request was created before resending.", "content": { "application/json": { "example": { "success": false, "message": "Error while processing request" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Error while processing request" } } } } } } }, "deprecated": false } }, "/api/3/withdrawal/crypto/{uuid}/cancel": { "post": { "tags": [ "Withdrawals" ], "summary": "Cancel Crypto Withdrawal Request", "description": "Withdraw a crypto request from the approval queue while it is still awaiting acceptance. Possible only from `PENDING_APPROVAL`, and that window closes as soon as Operations accepts the request into the processing queue - earlier than the equivalent fiat window. Afterwards the call returns `409` with the state unchanged.", "operationId": "cancel-crypto-withdrawal", "parameters": [ { "name": "Rest-Key", "in": "header", "description": "API key for authentication", "required": true, "schema": { "type": "string" } }, { "name": "Rest-Sign", "in": "header", "description": "Calculated API Signature", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The withdrawal request's `uuid`, as returned by the submit call or the matching list endpoint." } ], "requestBody": { "content": { "application/json": { "example": { "tonce": 1770888183656000, "accountGroupUuid": "2073252c-81ed-41be-bf4d-d51b8f2246b8" }, "schema": { "type": "object", "required": [ "tonce", "accountGroupUuid" ], "properties": { "tonce": { "type": "integer", "format": "int64", "description": "The current Unix time in microseconds. Accepted only within two minutes of server time. Send either `tonce` or `nonce`." }, "nonce": { "type": "integer", "format": "int64", "description": "Alternative to `tonce`, and takes precedence when both are sent. Must be a whole number and **strictly increasing** for a given API key: a reused or lower value is rejected. A request carrying neither `nonce` nor `tonce` is rejected with `401`." }, "accountGroupUuid": { "type": "string", "description": "The account group the request belongs to. **Goes in the body, not the query string** - the signature covers the path and the body only, so a value on the URL would be unsigned and is not read. Sending `?accountGroupUuid=...` and omitting it from the body returns `403 Invalid signed params`." } } } } } }, "responses": { "200": { "description": "Cancelled. The request now reports `CANCELLED`.", "content": { "application/json": { "example": { "success": true, "uuid": "e1b2c3d4-5a6b-7c8d-9e0f-1a2b3c4d5e6f" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "uuid": { "type": "string", "example": "e1b2c3d4-5a6b-7c8d-9e0f-1a2b3c4d5e6f", "description": "The cancelled request's identifier." } } } } } }, "401": { "description": "Authentication failed: unknown key, bad signature, a missing, malformed, reused or decreasing `nonce` or out-of-window `tonce`, a body that is not parseable JSON, or a throttled caller. Rate limiting surfaces here as `401`, not `429`.", "content": { "application/json": { "example": { "success": false, "message": "Unauthorized" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized" } } } } } }, "403": { "description": "`accountGroupUuid` missing or blank in the body (`Invalid signed params`), the API key lacks the Move Funds permission (`MOVE FUNDS permission required`), or you do not hold `ROLE_OPERATIONS` on that account group (`You do not have permission to perform this action`).", "content": { "application/json": { "example": { "success": false, "message": "Invalid signed params" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid signed params" } } } } } }, "404": { "description": "No withdrawal request with that `uuid` exists in that account group.", "content": { "application/json": { "example": { "success": false, "message": "Request not found" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Request not found" } } } } } }, "409": { "description": "The request is no longer in `PENDING_APPROVAL`. Its state is unchanged.", "content": { "application/json": { "example": { "success": false, "message": "Request can not be cancelled in current state" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Request can not be cancelled in current state" } } } } } }, "500": { "description": "Unexpected error. The outcome is undefined - for a submit, use the list endpoint to establish whether the request was created before resending.", "content": { "application/json": { "example": { "success": false, "message": "Error while processing request" }, "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Error while processing request" } } } } } } }, "deprecated": false } } } }