{ "info": { "name": "RoxCustody API", "description": "API collection for RoxCustody platform", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_postman_id": "e18b130c2ce68efdcb622ed7", "version": "1.0.0" }, "item": [ { "name": "Authentication", "item": [ { "name": "Generate Tokens", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/generate-tokens", "host": [ "{{baseUrl}}" ], "path": [ "auth", "generate-tokens" ] }, "description": "Generates access tokens using an API key.", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"YOUR-ACCESS-TOKEN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Tokens Generated", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/generate-tokens", "host": [ "{{baseUrl}}" ], "path": [ "auth", "generate-tokens" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Vault API Keys generated successfully\",\n \"data\": {\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"expiresAt\": 1767258052423\n, \n \"vaultId\": 1\n },\n \"status\": 201\n}" }, { "name": "Invalid API Key", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/generate-tokens", "host": [ "{{baseUrl}}" ], "path": [ "auth", "generate-tokens" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Invalid API Key\",\n \"errors\": {\n \"message\": \"Invalid API Key\"\n },\n \"code\": \"E40000\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/generate-tokens", "host": [ "{{baseUrl}}" ], "path": [ "auth", "generate-tokens" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"apiKey must be a string\",\n \"errors\": {\n \"message\": \"apiKey must be a string\",\n \"apiKey\": [\n \"apiKey must be a string\",\n \"The apiKey must not exceed 255 characters\",\n \"apiKey should not be empty\"\n ]\n },\n \"code\": \"E42200\"\n}" }, { "name": "Invalid Access Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/generate-tokens", "host": [ "{{baseUrl}}" ], "path": [ "auth", "generate-tokens" ] } }, "status": "401", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 401,\n \"message\": \"Invalid access token\",\n \"errors\": {\n \"message\": \"Invalid access token\"\n },\n \"code\": \"E40001\"\n}" }, { "name": "Token Expired", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/generate-tokens", "host": [ "{{baseUrl}}" ], "path": [ "auth", "generate-tokens" ] } }, "status": "498", "code": 498, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 498,\n \"message\": \"Token has expired\",\n \"errors\": {\n \"message\": \"Token has expired\"\n },\n \"code\": \"E40003\"\n}" } ] }, { "name": "Refresh Token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/refresh-token", "host": [ "{{baseUrl}}" ], "path": [ "auth", "refresh-token" ] }, "description": "Refreshes the access token using a refresh token.", "body": { "mode": "raw", "raw": "{\n \"refreshToken\": \"YOUR-REFRESH-TOKEN\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Tokens Refreshed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/refresh-token", "host": [ "{{baseUrl}}" ], "path": [ "auth", "refresh-token" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Vault API Keys generated successfully\",\n \"data\": {\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"expiresAt\": 1767258052423\n },\n \"status\": 201\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/refresh-token", "host": [ "{{baseUrl}}" ], "path": [ "auth", "refresh-token" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"refreshToken must be a string\",\n \"errors\": {\n \"message\": \"refreshToken must be a string\",\n \"refreshToken\": [\n \"refreshToken must be a string\",\n \"The refreshToken must not exceed 255 characters\",\n \"refreshToken should not be empty\"\n ]\n },\n \"code\": \"E42200\"\n}" }, { "name": "Invalid Refresh Token", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/refresh-token", "host": [ "{{baseUrl}}" ], "path": [ "auth", "refresh-token" ] } }, "status": "401", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 401,\n \"message\": \"Invalid refresh token\",\n \"errors\": {\n \"message\": \"Invalid refresh token\"\n },\n \"code\": \"E40002\"\n}" }, { "name": "Refresh Token Expired Or No Longer Valid", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/auth/refresh-token", "host": [ "{{baseUrl}}" ], "path": [ "auth", "refresh-token" ] } }, "status": "401", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 401,\n \"message\": \"Refresh token is no longer valid. Please generate a new session.\",\n \"errors\": {\n \"message\": \"Refresh token is no longer valid. Please generate a new session.\"\n },\n \"code\": \"E40002\"\n}" } ] } ], "description": "Manage authentication and authorization for the RoxCustody API. Generate access tokens using API keys and refresh tokens to maintain secure access to the platform. Authentication is required for all API requests and tokens must be included in the X-ACCESS-TOKEN header." }, { "name": "Clients", "item": [ { "name": "Create One Client Wallets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "create" ] }, "description": "Creates a new client linked to this vault and creates new wallets for each of the integrated blockchains. Clients represent external entities in segregated and consolidated vaults - they are identified by an externalId (your system's ID) and are used to separate funds and transactions by client in RoxCustody.", "body": { "mode": "raw", "raw": "{\n \"id\": \"client123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Client Created Successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "create" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Client created successfully.\",\n \"client\": {\n \"externalId\": \"client123\",\n \"id\": 4,\n \"createdAt\": \"20 August, 2025 11:18:53\",\n \"updatedAt\": \"20 August, 2025 11:18:53\"\n },\n \"status\": 201\n}" }, { "name": "Vault Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "create" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Vault not found, or vault type is not allowed for creating clients\",\n \"errors\": {\n \"message\": \"Vault not found, or vault type is not allowed for creating clients\"\n },\n \"code\": \"E40401\"\n}" }, { "name": "Client ID Already Exists", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "create" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":422,\"message\":\"UnprocessableEntityException\",\"errors\":{\"clients\":[{\"id\":1,\"externalId\":\"client\"}]},\"code\":\"E42201\"}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "create" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"id must be a string\",\n \"errors\": {\n \"message\": \"id must be a string\",\n \"id\": [\n \"id must be a string\",\n \"The value must not exceed 255 characters\",\n \"The id field is required.\"\n ]\n },\n \"code\": \"E42200\"\n}" } ] }, { "name": "Create Clients Wallets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/bulk-create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "bulk-create" ] }, "description": "Creates multiple clients at once linked to this vault and creates new wallets for each of the integrated blockchains. Clients represent external entities in segregated and consolidated vaults - they are identified by an externalId (your system's ID) and are used to separate funds and transactions by client in RoxCustody.", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"client1\",\n \"client2\",\n \"client3\",\n \"client4\",\n \"client5\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Clients Created Successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/bulk-create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "bulk-create" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Clients created successfully.\",\n \"clients\": [\n {\n \"externalId\": \"client1\",\n \"id\": 9,\n \"createdAt\": \"20 August, 2025 11:51:20\",\n \"updatedAt\": \"20 August, 2025 11:51:20\"\n },\n {\n \"externalId\": \"client2\",\n \"id\": 10,\n \"createdAt\": \"20 August, 2025 11:51:20\",\n \"updatedAt\": \"20 August, 2025 11:51:20\"\n },\n {\n \"externalId\": \"client3\",\n \"id\": 11,\n \"createdAt\": \"20 August, 2025 11:51:20\",\n \"updatedAt\": \"20 August, 2025 11:51:20\"\n },\n {\n \"externalId\": \"client4\",\n \"id\": 12,\n \"createdAt\": \"20 August, 2025 11:51:20\",\n \"updatedAt\": \"20 August, 2025 11:51:20\"\n },\n {\n \"externalId\": \"client5\",\n \"id\": 13,\n \"createdAt\": \"20 August, 2025 11:51:20\",\n \"updatedAt\": \"20 August, 2025 11:51:20\"\n }\n ],\n \"status\": 201\n}" }, { "name": "Some Client IDs Already Exist", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/bulk-create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "bulk-create" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":422,\"message\":\"UnprocessableEntityException\",\"errors\":{\"clients\":[{\"id\":1,\"externalId\":\"client1\"}, {\"id\":2,\"externalId\":\"client2\"}, {\"id\":3,\"externalId\":\"client3\"}]},\"code\":\"E42201\"}" }, { "name": "Vault Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/bulk-create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "bulk-create" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Vault not found, or vault type is not allowed for creating clients\",\n \"errors\": {\n \"message\": \"Vault not found, or vault type is not allowed for creating clients\"\n },\n \"code\": \"E40401\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/clients/bulk-create", "host": [ "{{baseUrl}}" ], "path": [ "clients", "bulk-create" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"Each value must not exceed 255 characters\",\n \"errors\": {\n \"message\": \"Each value must not exceed 255 characters\",\n \"ids\": [\n \"Each value must not exceed 255 characters\",\n \"each value in ids must be a string\",\n \"The ids field is required.\",\n \"ids must not be empty\",\n \"ids must be an array\"\n ]\n },\n \"code\": \"E42200\"\n}" } ] } ], "description": "Clients represent external entities in segregated and consolidated vaults. They are identified by an externalId (your system's ID) and are used to separate funds and transactions by client in RoxCustody. When you create a client, the system automatically creates wallets for each integrated blockchain network. Clients are essential for maintaining separate accounting and transaction history for different customers or entities." }, { "name": "Wallets", "item": [ { "name": "Get All Clients' Wallets", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/client-wallets?page=&limit=&sortKey=&order=&search=&clientId=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "client-wallets" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page number of results to return.", "disabled": false }, { "key": "limit", "value": "", "description": "Limits the number of results returned.", "disabled": false }, { "key": "sortKey", "value": "", "description": "Sort results by one of the following: 'id', 'balance'.", "disabled": false }, { "key": "order", "value": "", "description": "Sort order: 'asc' for ascending or 'desc' for descending.", "disabled": false }, { "key": "search", "value": "", "description": "Searches by Wallet Public Address or Asset Name or Asset Contract Address.", "disabled": false }, { "key": "clientId", "value": "", "description": "Filter by Client ID.", "disabled": false }, { "key": "filters", "value": "", "description": "Filters results.", "disabled": false } ] }, "description": "Returns all the clients' wallets for each of the integrated blockchains." }, "response": [ { "name": "Wallets Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/client-wallets?page=&limit=&sortKey=&order=&search=&clientId=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "client-wallets" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Clients' Wallets\",\n \"data\": [\n {\n \"id\": 80,\n \"balance\": \"0\",\n \"pendingBalance\": \"0\",\n \"publicAddress\": \"npSrSWmLQv6hTPcStg44tPrqTfmTwYiy7hU8RpoTrE6\",\n \"transactionsCount\": \"0\",\n \"targetId\": \"2\",\n \"protocol\": 0,\n \"asset\": {\n \"id\": 2168,\n \"name\": \"USDC\",\n \"symbol\": \"USDC\",\n \"contractAddress\": \"4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU\",\n \"decimals\": 6,\n \"type\": \"TOKEN\",\n \"status\": \"ACTIVE\",\n \"logo\": \"https://api-super-admin-custody-demo.roxcustody.com/public/files/assets/usdc.png\"\n },\n \"type\": \"CLIENT\"\n }\n ],\n \"meta\": {\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"nextCursor\": null,\n \"previousCursor\": null,\n \"limit\": 10\n },\n \"status\": 200\n}" }, { "name": "Invalid Filters Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/client-wallets?page=&limit=&sortKey=&order=&search=&clientId=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "client-wallets" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"filters must have valid values according to publicAddress,targetId,assetId,type.\",\n \"errors\": {\n \"message\": \"filters must have valid values according to publicAddress,targetId,assetId,type.\",\n \"filters\": [\n \"filters must have valid values according to publicAddress,targetId,assetId,type.\"\n ]\n },\n \"code\": \"E42200\"\n}" }, { "name": "Client not found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/client-wallets?page=&limit=&sortKey=&order=&search=&clientId=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "client-wallets" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Client not found in this vault\",\n \"errors\": {\n \"message\": \"Client not found in this vault\"\n},\n \"code\": \"E40402\"\n}" } ] }, { "name": "Get Vault Gas Station Wallets", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/gas-station-wallets?page=&limit=&sortKey=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "gas-station-wallets" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page number of results to return.", "disabled": false }, { "key": "limit", "value": "", "description": "Limits the number of results returned.", "disabled": false }, { "key": "sortKey", "value": "", "description": "Sort results by field name.", "disabled": false }, { "key": "search", "value": "", "description": "Search term for filtering results.", "disabled": false }, { "key": "filters", "value": "", "description": "Filters results.", "disabled": false } ] }, "description": "Returns all gas station wallets for the current vault." }, "response": [ { "name": "Gas Station Wallets Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/gas-station-wallets?page=&limit=&sortKey=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "gas-station-wallets" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Gas station wallets\",\n \"data\": [\n {\n \"id\": 1,\n \"balance\": \"0\",\n \"pendingBalance\": \"0\",\n \"publicAddress\": \"0x73dfa3ccf752B3704785EAc599F616053eFF9A81\",\n \"transactionsCount\": \"0\",\n \"targetId\": 1,\n \"asset\": {\n \"id\": 1,\n \"name\": \"Ether\",\n \"symbol\": \"ETH\",\n \"contractAddress\": null,\n \"decimals\": 18,\n \"network\": {\n \"id\": 1,\n \"name\": \"Ethereum\",\n \"symbol\": \"ETH\",\n \"createdAt\": \"05 August, 2025 07:23:30\",\n \"updatedAt\": \"05 August, 2025 07:23:30\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"http://localhost:5000/public/files/assets/ethereum.png\",\n \"isSwappable\": true,\n \"category\": \"EVM\",\n \"chain\": {\n \"id\": 1,\n \"name\": \"Ethereum\",\n \"nativeCurrency\": {\n \"name\": \"Ether\",\n \"symbol\": \"ETH\",\n \"decimals\": 18\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [\n \"https://eth.llamarpc.com\",\n \"https://rpc.ankr.com/eth\"\n ]\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Etherscan\",\n \"url\": \"https://etherscan.io\",\n \"apiUrl\": \"https://api.etherscan.io/api\"\n }\n }\n }\n },\n \"createdAt\": \"05 August, 2025 07:23:31\",\n \"updatedAt\": \"05 August, 2025 07:23:31\",\n \"type\": \"COIN\",\n \"status\": \"ACTIVE\",\n \"logo\": \"http://localhost:5000/public/files/assets/ethereum.png\"\n },\n \"createdAt\": \"05 August, 2025 07:44:57\",\n \"updatedAt\": \"05 August, 2025 07:44:57\",\n \"type\": \"GAS_STATION\"\n }\n ],\n \"meta\": {\n \"totalItems\": 1,\n \"itemsPerPage\": 10,\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n },\n \"status\": 200\n}" }, { "name": "Invalid Filters Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/gas-station-wallets?page=&limit=&sortKey=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "gas-station-wallets" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"filters must have valid values according to publicAddress,targetId,assetId.\",\n \"errors\": {\n \"message\": \"filters must have valid values according to publicAddress,targetId,assetId.\",\n \"filters\": [\n \"filters must have valid values according to publicAddress,targetId,assetId.\"\n ]\n },\n \"code\": \"E42200\"\n}" } ] }, { "name": "Get Wallet by ID", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/:walletId", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "{{walletId}}" ], "variable": [ { "key": "walletId", "value": "{{walletId}}", "description": "walletId parameter" } ] }, "description": "Returns the details of a specific wallet by its ID." }, "response": [ { "name": "Wallet Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/:walletId", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "{{walletId}}" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Wallet balance\",\n \"data\": {\n \"id\": 2322,\n \"balance\": \"0\",\n \"pendingBalance\": \"0\",\n \"publicAddress\": \"0x102354614119CD8B3654a7D89128E0474e908705\",\n \"transactionsCount\": \"0\",\n \"targetId\": 14,\n \"createdAt\": \"20 August, 2025 12:01:13\",\n \"updatedAt\": \"20 August, 2025 12:01:13\",\n \"type\": \"CLIENT\"\n },\n \"status\": 200\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/:walletId", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "{{walletId}}" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Validation failed (numeric string is expected)\",\n \"errors\": {\n \"message\": \"Validation failed (numeric string is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n },\n \"code\": \"E42200\"\n}" }, { "name": "Wallet Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/:walletId", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "{{walletId}}" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Can't find this wallet\",\n \"errors\": {\n \"message\": \"Can't find this wallet\"\n },\n \"code\": \"E40403\"\n}" } ] }, { "name": "Get Client Native Coin Wallet by Network", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/client-wallet-by-network/:networkId/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "client-wallet-by-network", "{{networkId}}", "{{clientId}}" ], "variable": [ { "key": "networkId", "value": "{{networkId}}", "description": "networkId parameter" }, { "key": "clientId", "value": "{{clientId}}", "description": "clientId parameter" } ] }, "description": "Returns the client's native coin wallet for a specific blockchain network." }, "response": [ { "name": "Client Wallet Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/client-wallet-by-network/:networkId/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "client-wallet-by-network", "{{networkId}}", "{{clientId}}" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Client wallet by network\",\n \"data\": {\n \"id\": 439,\n \"balance\": \"0\",\n \"pendingBalance\": \"0\",\n \"publicAddress\": \"0x8ba2bC564C5ddfDdb45FD1831F3A3A63A867cB39\",\n \"transactionsCount\": \"0\",\n \"targetId\": 4,\n \"asset\": {\n \"id\": 1817,\n \"name\": \"Ether\",\n \"symbol\": \"ETH\",\n \"contractAddress\": null,\n \"decimals\": 18,\n \"network\": {\n \"id\": 7,\n \"name\": \"Base\",\n \"symbol\": \"ETH\",\n \"createdAt\": \"05 August, 2025 07:23:32\",\n \"updatedAt\": \"05 August, 2025 07:23:32\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"http://localhost:5000/public/files/assets/base.png\",\n \"isSwappable\": true,\n \"category\": \"EVM\",\n \"chain\": {\n \"id\": 8453,\n \"name\": \"Base\",\n \"nativeCurrency\": {\n \"name\": \"Ether\",\n \"symbol\": \"ETH\",\n \"decimals\": 18\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [\n \"https://mainnet.base.org\"\n ]\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Basescan\",\n \"url\": \"https://basescan.org\",\n \"apiUrl\": \"https://api.basescan.org/api\"\n }\n }\n }\n },\n \"createdAt\": \"05 August, 2025 07:23:32\",\n \"updatedAt\": \"05 August, 2025 07:23:32\",\n \"type\": \"COIN\",\n \"status\": \"ACTIVE\",\n \"logo\": \"http://localhost:5000/public/files/assets/base.png\"\n },\n \"createdAt\": \"20 August, 2025 11:18:54\",\n \"updatedAt\": \"20 August, 2025 11:18:54\",\n \"type\": \"CLIENT\"\n },\n \"status\": 200\n}" }, { "name": "Wallet Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/client-wallet-by-network/:networkId/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "client-wallet-by-network", "{{networkId}}", "{{clientId}}" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Can't find this wallet\",\n \"errors\": {\n \"message\": \"Can't find this wallet\"\n },\n \"code\": \"E40403\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/wallets/client-wallet-by-network/:networkId/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "wallets", "client-wallet-by-network", "{{networkId}}", "{{clientId}}" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Validation failed (numeric string is expected)\",\n \"errors\": {\n \"message\": \"Validation failed (numeric string is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n },\n \"code\": \"E40000\"\n}" } ] } ], "description": "Manage and query wallet information. Wallets are blockchain addresses associated with clients in RoxCustody. Each client automatically receives wallets for each integrated blockchain network. Wallets store cryptocurrency balances and track transaction history. You can query wallet balances, transaction counts, and filter wallets by various criteria such as client, asset, or network." }, { "name": "Vaults", "item": [ { "name": "Get Vault Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/details", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "details" ] }, "description": "Returns details of vaults." }, "response": [ { "name": "Vault Details Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/details", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "details" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Vault Details\",\n \"data\": {\n \"id\": 22,\n \"name\": \"Webhooks Vault\",\n \"gasStationCategoryId\": 1,\n \"percentageToStoreInCustody\": 50,\n \"allowedOrigins\": [\n \"*\"\n ],\n \"webhookId\": 1,\n \"createdAt\": \"26 August, 2025 10:37:17\",\n \"updatedAt\": \"10 September, 2025 08:54:41\",\n \"fiatCurrencyDetails\": {\n \"id\": 5,\n \"name\": \"US Dollar\",\n \"symbol\": \"$\",\n \"pricingId\": \"usd\"\n },\n \"gasStationCategory\": {\n \"id\": 1,\n \"name\": \"General\"\n },\n \"paymentPolicyId\": 22,\n \"photo\": null,\n \"vaultType\": \"api_segregated\",\n \"admins\": [\n {\n \"id\": 1,\n \"name\": \"super admin\"\n }\n ],\n \"walletsStatus\": \"Synced\"\n },\n \"status\": 200\n}" }, { "name": "Vault Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/details", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "details" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Vault not found\",\n \"errors\": {\n \"message\": \"Vault not found\"\n },\n \"code\": \"E40404\"\n}" } ] }, { "name": "Get Vault Approvals", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/approvals?page=&limit=&sortKey=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "approvals" ], "query": [ { "key": "page", "value": "", "description": "Specifies the page number of results to return.", "disabled": false }, { "key": "limit", "value": "", "description": "Limits the number of results returned.", "disabled": false }, { "key": "sortKey", "value": "", "description": "Sort results by fields ('id', 'name', 'email', 'status').", "disabled": false }, { "key": "search", "value": "", "description": "Search term for filtering results by fields ('name', 'email', 'phone').", "disabled": false }, { "key": "filters", "value": "", "description": "Additional filters for the query.", "disabled": false } ] }, "description": "Returns all vault approvals for the current vault." }, "response": [ { "name": "Vault Approvals Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/approvals?page=&limit=&sortKey=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "approvals" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Vault Approvals\",\n \"data\": {\n \"id\": 1,\n \"phone\": null,\n \"name\": \"rox\",\n \"email\": \"rox@example.com\",\n \"isTwoFactorEnabled\": \"false\",\n \"mustActivateTwoFactorAuth\": \"false\",\n \"createdAt\": \"17 November, 2024 13:19:03\",\n \"updatedAt\": \"17 November, 2024 13:44:01\"\n },\n \"status\": 200\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/approvals?page=&limit=&sortKey=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "approvals" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"The value for property 'roleId' must be of type number,In(number, number),NotIn(number, number).\",\n \"errors\": {\n \"message\": \"The value for property 'roleId' must be of type number,In(number, number),NotIn(number, number).\",\n \"filters\": [\n \"The value for property 'roleId' must be of type number,In(number, number),NotIn(number, number).\"\n ]\n },\n \"code\": \"E42200\"\n}" } ] }, { "name": "Get Vault Assets", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/assets?page=&limit=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "assets" ], "query": [ { "key": "page", "value": "", "description": "Page number for pagination", "disabled": false }, { "key": "limit", "value": "", "description": "Number of items per page", "disabled": false }, { "key": "search", "value": "", "description": "Search term for filtering results by fields ('name', 'symbol', 'contractAddress').", "disabled": false }, { "key": "filters", "value": "", "description": "Additional filters for the query.", "disabled": false } ] }, "description": "Returns all assets available in a vault." }, "response": [ { "name": "Vault Assets Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/assets?page=&limit=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "assets" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Vault Assets\",\n \"data\": [\n {\n \"id\": 2282,\n \"name\": \"USDC\",\n \"symbol\": \"USDC\",\n \"contractAddress\": \"4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU\",\n \"decimals\": 6,\n \"network\": {\n \"id\": 18,\n \"name\": \"Solana Devnet\",\n \"symbol\": \"SOL\",\n \"isSwappable\": false,\n \"chain\": {\n \"id\": 245022926,\n \"name\": \"Solana Devnet\",\n \"nativeCurrency\": {\n \"name\": \"Solana Devnet\",\n \"symbol\": \"SOL\",\n \"decimals\": 9\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [],\n \"webSocket\": []\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Solscan\",\n \"url\": \"https://solscan.io\",\n \"apiUrl\": \"https://api.devnet.solana.com\"\n }\n }\n }\n },\n \"createdAt\": \"28 May, 2025 08:33:03\",\n \"updatedAt\": \"14 July, 2025 09:00:08\",\n \"vaultStatus\": \"active\",\n \"type\": \"TOKEN\",\n \"status\": \"ACTIVE\",\n \"logo\": \"http://localhost:5000/public/files/assets/usdc.png\"\n }\n ],\n \"meta\": {\n \"totalItems\": 1,\n \"itemsPerPage\": 10,\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n },\n \"status\": 200\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/assets?page=&limit=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "assets" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"filters must have valid values according to id,status,type,networkId,vaultAssets,vaultAssetsStatus,isSwappable.\",\n \"errors\": {\n \"message\": \"filters must have valid values according to id,status,type,networkId,vaultAssets,vaultAssetsStatus,isSwappable.\",\n \"filters\": [\n \"filters must have valid values according to id,status,type,networkId,vaultAssets,vaultAssetsStatus,isSwappable.\"\n ]\n },\n \"code\": \"E42200\"\n}" } ] }, { "name": "Get Vault Networks", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/networks?page=&limit=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "networks" ], "query": [ { "key": "page", "value": "", "description": "Page number for pagination", "disabled": false }, { "key": "limit", "value": "", "description": "Number of items per page", "disabled": false }, { "key": "search", "value": "", "description": "Search term for filtering results by fields ('name', 'symbol').", "disabled": false }, { "key": "filters", "value": "", "description": "Additional filters for the query.", "disabled": false } ] }, "description": "Returns all networks available in a vault." }, "response": [ { "name": "Vault Networks Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/networks?page=&limit=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "networks" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Vault Networks\",\n \"data\": [\n {\n \"name\": \"Solana Devnet\",\n \"logo\": \"http://localhost:5000/public/files/assets/solana.png\",\n \"symbol\": \"SOL\",\n \"id\": 18,\n \"category\": \"Solana\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"meta\": {\n \"totalItems\": 1,\n \"itemsPerPage\": 10,\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n },\n \"status\": 200\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/networks?page=&limit=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "networks" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"The value for property 'status' must be of type enum[HOLD,ACTIVE] .\",\n \"errors\": {\n \"message\": \"The value for property 'status' must be of type enum[HOLD,ACTIVE] .\",\n \"filters\": [\n \"The value for property 'status' must be of type enum[HOLD,ACTIVE] .\"\n ]\n },\n \"code\": \"E42200\"\n}" }, { "name": "Invalid Filter Values Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/networks?page=&limit=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "networks" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"filters must have valid values according to id,status,type,isTestnet.\",\n \"errors\": {\n \"message\": \"filters must have valid values according to id,status,type,isTestnet.\",\n \"filters\": [\n \"filters must have valid values according to id,status,type,isTestnet.\"\n ]\n },\n \"code\": \"E42200\"\n}" } ] }, { "name": "Get Vault Payment Policy", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/payment-policy", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "payment-policy" ] }, "description": "Returns the payment policy configuration for a vault." }, "response": [ { "name": "Vault Payment Policy Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vaults/payment-policy", "host": [ "{{baseUrl}}" ], "path": [ "vaults", "payment-policy" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Vault Payment Policy\",\n \"data\": {\n \"paymentPolicy\": {\n \"id\": 26,\n \"ranges\": [\n {\n \"id\": 13,\n \"from\": \"0.00000000000000000000\",\n \"to\": \"100000.00000000000000000000\",\n \"dailyLimit\": null,\n \"createdAt\": \"20 August, 2025 14:43:29\",\n \"updatedAt\": \"20 August, 2025 14:43:29\",\n \"paymentPolicyRangeType\": \"api\",\n \"minimumNumberOfApprovals\": null\n }\n ],\n \"createdAt\": \"20 August, 2025 14:43:29\",\n \"updatedAt\": \"20 August, 2025 14:43:29\"\n }\n },\n \"status\": 200\n}" } ] }, { "name": "Get Master Wallet", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/integration/vaults/master-wallets?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "integration", "vaults", "master-wallets" ], "query": [ { "key": "cursor", "value": "", "description": "Cursor for pagination. Use the `nextCursor` or `previousCursor` from a previous response to navigate between pages.", "disabled": false }, { "key": "limit", "value": "", "description": "Limits the number of results returned per page.", "disabled": false } ] }, "description": "Returns the master wallets for the authenticated vault. Uses cursor-based pagination for efficient navigation through large datasets." }, "response": [ { "name": "Master Wallets Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/integration/vaults/master-wallets?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "integration", "vaults", "master-wallets" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"wallets\",\n \"data\": [\n {\n \"id\": 82926,\n \"balance\": \"964.551212121\",\n \"pendingBalance\": \"0\",\n \"publicAddress\": \"D3usfqaJLkFZXpZKovRq3tEL49sAtaqajeTZPymgQraU\",\n \"transactionsCount\": \"0\",\n \"targetId\": \"3\",\n \"asset\": {\n \"id\": 2169,\n \"name\": \"Rox\",\n \"symbol\": \"ROX\",\n \"contractAddress\": null,\n \"decimals\": 9,\n \"network\": {\n \"id\": 28,\n \"name\": \"Rox Chain\",\n \"symbol\": \"ROX\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\n \"isSwappable\": false,\n \"category\": \"Solana\",\n \"chain\": {\n \"id\": 245022934,\n \"name\": \"Rox Chain\",\n \"nativeCurrency\": {\n \"name\": \"Rox\",\n \"symbol\": \"ROX\",\n \"decimals\": 9\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [],\n \"webSocket\": []\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Rox chain explorer\",\n \"url\": \"https://explorer.roxchain.io\",\n \"apiUrl\": \"https://rpc.roxchain.io\"\n }\n }\n },\n \"addressFormat\": {\n \"prefixes\": [\n \"\"\n ],\n \"lengthRange\": [\n 32,\n 44\n ]\n }\n },\n \"vaultStatus\": \"active\",\n \"isHidden\": false,\n \"type\": \"COIN\",\n \"status\": \"ACTIVE\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\"\n },\n \"type\": \"MASTER\"\n }\n ],\n \"meta\": {\n \"hasNextPage\": true,\n \"hasPreviousPage\": true,\n \"nextCursor\": \"eyJzIjo4MjkyNiwiaSI6ODI5MjZ9\",\n \"previousCursor\": \"eyJzIjo4MjkyNiwiaSI6ODI5MjYsImQiOiJwcmV2In0=\",\n \"limit\": 1\n },\n \"status\": 200\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/integration/vaults/master-wallets?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "integration", "vaults", "master-wallets" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Bad Request Exception\",\n \"errors\": {\n \"message\": [\n \"property limits should not exist\"\n ],\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n },\n \"code\": \"E50001\"\n}" } ] } ], "description": "Access vault details and configuration. Vaults are the primary organizational unit in RoxCustody that contain clients, wallets, and assets. Each vault represents a separate custody environment with its own configuration, payment policies, gas station categories, and network settings. View vault details, assets, networks, approvals, and payment policies." }, { "name": "Transactions", "item": [ { "name": "Create Transaction", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] }, "description": "Creates a new outgoing transaction from a client wallet.", "body": { "mode": "raw", "raw": "{\n \"amount\": 0.1,\n \"walletId\": 246,\n \"receiverAddress\": \"TV77cjwVydiysagUWWDqGrqQyjfVLVyFQw\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Transaction Created Successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Your transaction is pending\",\n \"transaction\": {\n \"dollarAmount\": \"0.00330604\",\n \"feesDollarAmount\": \"0.4754184028\",\n \"walletId\": 246,\n \"senderAddress\": \"TXWmdV24rFYyqmA44uQnYfgs12xSQdp5ok\",\n \"receiverAddress\": \"TV77cjwVydiysagUWWDqGrqQyjfVLVyFQw\",\n \"gasStationCategoryWalletId\": 4,\n \"parentId\": null,\n \"asset\": {\n \"id\": 2289,\n \"name\": \"JUST GOV\",\n \"symbol\": \"JST\",\n \"contractAddress\": \"TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3\",\n \"decimals\": 18,\n \"network\": {\n \"id\": 22,\n \"name\": \"Tron (Nile)\",\n \"symbol\": \"TRX\",\n \"createdAt\": \"05 August, 2025 07:23:33\",\n \"updatedAt\": \"05 August, 2025 07:23:33\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"http://localhost:5000/public/files/assets/tron.png\",\n \"isSwappable\": false,\n \"category\": \"Tron\",\n \"chain\": {\n \"id\": 3448148188,\n \"name\": \"Tron (Nile)\",\n \"nativeCurrency\": {\n \"name\": \"Tron (Nile)\",\n \"symbol\": \"TRX\",\n \"decimals\": 6\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [],\n \"webSocket\": []\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Tron (Nile)\",\n \"url\": \"https://nile.tronscan.org/\",\n \"apiUrl\": \"https://nile.trongrid.io\"\n }\n }\n }\n },\n \"createdAt\": \"05 August, 2025 07:23:33\",\n \"updatedAt\": \"05 August, 2025 07:23:33\",\n \"type\": \"TOKEN\",\n \"status\": \"ACTIVE\",\n \"logo\": \"http://localhost:5000/public/files/assets/just-gov.png\"\n },\n \"id\": 388,\n \"createdAt\": \"21 August, 2025 11:27:36\",\n \"updatedAt\": \"21 August, 2025 11:27:36\",\n \"markup\": \"0 TRX\",\n \"type\": \"Outgoing\",\n \"status\": \"PENDING\",\n \"coinSymbol\": \"TRX\",\n \"paymentPolicyType\": \"api\",\n \"amount\": \"0.1\",\n \"fees\": \"1.3532\"\n },\n \"status\": 201\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"Please enter a valid amount\",\n \"errors\": {\n \"message\": \"Please enter a valid amount\",\n \"amount\": [\n \"Please enter a valid amount\",\n \"The amount field is required.\"\n ],\n \"walletId\": [\n \"The walletId field is required.\",\n \"The value must be a number\",\n \"The value must be a positive number\",\n \"The value must be an integer\"\n ],\n \"receiverAddress\": [\n \"receiver address must be a string\",\n \"The value must not exceed 255 characters\",\n \"The receiverAddress field is required.\"\n ]\n },\n \"code\": \"E42200\"\n}" }, { "name": "Insufficient Balance", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"Insufficient balance\",\n \"errors\": {\n \"message\": \"Insufficient balance\"\n },\n \"code\": \"E60004\"\n}" } ] }, { "name": "Get Transaction Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{id}}" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "id parameter" } ] }, "description": "Returns the details of a specific transaction." }, "response": [ { "name": "Transaction Details Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{id}}" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Transaction\",\n \"transaction\": {\n \"id\": \"388\",\n \"vaultId\": 1,\n \"dollarAmount\": \"0.00330604000000000000\",\n \"feesDollarAmount\": \"0.47541840280000000000\",\n \"walletId\": \"246\",\n \"senderAddress\": \"TXWmdV24rFYyqmA44uQnYfgs12xSQdp5ok\",\n \"receiverAddress\": \"TV77cjwVydiysagUWWDqGrqQyjfVLVyFQw\",\n \"encodedPayload\": null,\n \"note\": null,\n \"callMethod\": null,\n \"errorMessage\": \"this is a simulation\",\n \"gasStationCategoryWalletId\": \"4\",\n \"parentId\": null,\n \"statusChangedAt\": \"2025-08-21T08:29:51.000Z\",\n \"asset\": {\n \"id\": 2289,\n \"name\": \"JUST GOV\",\n \"symbol\": \"JST\",\n \"contractAddress\": \"TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3\",\n \"network\": {\n \"id\": 22,\n \"name\": \"Tron (Nile)\",\n \"symbol\": \"TRX\",\n \"logo\": \"http://localhost:5000/public/files/assets/tron.png\",\n \"isSwappable\": false,\n \"chain\": {\n \"id\": 3448148188,\n \"name\": \"Tron (Nile)\",\n \"nativeCurrency\": {\n \"name\": \"Tron (Nile)\",\n \"symbol\": \"TRX\",\n \"decimals\": 6\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [],\n \"webSocket\": []\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Tron (Nile)\",\n \"url\": \"https://nile.tronscan.org/\",\n \"apiUrl\": \"https://nile.trongrid.io\"\n }\n }\n }\n },\n \"logo\": \"http://localhost:5000/public/files/assets/just-gov.png\"\n },\n \"paymentPolicyRange\": null,\n \"admin\": null,\n \"createdAt\": \"21 August, 2025 11:27:36\",\n \"updatedAt\": \"21 August, 2025 11:29:51\",\n \"blockExplorerUrl\": \"https://nile.tronscan.org//#/transaction/0864a515d4f04e0cabf942a98e44d216\",\n \"markup\": \"0 TRX\",\n \"approvals\": [],\n \"type\": \"Outgoing\",\n \"transactionHash\": \"0864a515d4f04e0cabf942a98e44d216\",\n \"status\": \"COMPLETED\",\n \"coinSymbol\": \"TRX\",\n \"paymentPolicyType\": \"api\",\n \"amount\": \"0.1\",\n \"fees\": \"0.6766\"\n },\n \"status\": 200\n}" }, { "name": "Transaction Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{id}}" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Transaction not found\",\n \"errors\": {\n \"message\": \"Transaction not found\"\n },\n \"code\": \"E40405\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{id}}" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Validation failed (numeric string is expected)\",\n \"errors\": {\n \"message\": \"Validation failed (numeric string is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n },\n \"code\": \"E40000\"\n}" } ] }, { "name": "Get All Transactions", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:vaultId?cursor=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{vaultId}}" ], "query": [ { "key": "cursor", "value": "", "description": "Cursor for pagination. Provides a way to fetch the next or previous set of results.", "disabled": false }, { "key": "limit", "value": "", "description": "Limits the number of results returned.", "disabled": false }, { "key": "sortKey", "value": "", "description": "Sort results by one of the following: id, amount, dollarAmount, fees.", "disabled": false }, { "key": "order", "value": "", "description": "Sort order: 'ASC' for ascending or 'DESC' for descending.", "disabled": false }, { "key": "search", "value": "", "description": "Search by senderAddress, receiverAddress, asset.name, or blockchainTransactionId.", "disabled": false }, { "key": "filters", "value": "", "description": "Filters results by id, clientId, walletId, assetId, vaultId, gasStationCategoryId, systemFeesCategoryId, type, status, approvalTransactionActions, createdAt, updatedAt, networkId, senderAddress, receiverAddress.", "disabled": false } ], "variable": [ { "key": "vaultId", "value": "{{vaultId}}", "description": "vaultId parameter" } ] }, "description": "Returns all transactions for the current vault with pagination and filtering options." }, "response": [ { "name": "Transactions Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:vaultId?cursor=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{vaultId}}" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"vault transactions\",\n \"data\": [\n {\n \"id\": \"12\",\n \"dollarAmount\": \"0.50000000000000000000\",\n \"fiatAmount\": \"0.50000000000000000000\",\n \"senderAddress\": \"2ohp3pBjHLMLuKgaHZguDatFY7eUZn2XiPUCA7KgGNy9\",\n \"receiverAddress\": \"3M2vdeWjRWddacDCdKQveFHbgrfgSa8NuEjPtFjh5WHU\",\n \"feesPayerWalletId\": \"350292\",\n \"data\": null,\n \"asset\": {\n \"id\": 2170,\n \"name\": \"Rox\",\n \"symbol\": \"ROX\",\n \"network\": {\n \"id\": 29,\n \"name\": \"Rox Chain Devnet\",\n \"symbol\": \"ROX\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\n \"isSwappable\": false,\n \"chain\": {\n \"id\": 245022935,\n \"name\": \"Rox Chain Devnet\",\n \"nativeCurrency\": {\n \"name\": \"Rox\",\n \"symbol\": \"ROX\",\n \"decimals\": 9\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [],\n \"webSocket\": []\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Rox chain explorer\",\n \"url\": \"https://explorer.roxchain.io\",\n \"apiUrl\": \"https://rpc-dev.roxchain.io\"\n }\n },\n \"testnet\": true\n },\n \"addressFormat\": null\n },\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\"\n },\n \"createdAt\": \"24 March, 2026 19:29:21\",\n \"updatedAt\": \"24 March, 2026 19:29:27\",\n \"blockExplorerUrl\": \"https://explorer.roxchain.io/tx/85299572755017334673545733533775374353542573657?cluster=devnet\",\n \"markup\": \"0 ROX\",\n \"approvals\": [],\n \"type\": \"Incoming\",\n \"transactionHash\": \"85299572755017334673545733533775374353542573657\",\n \"status\": \"COMPLETED\",\n \"coinSymbol\": \"ROX\",\n \"paymentPolicyType\": null,\n \"amount\": \"0.5\",\n \"fees\": \"0.0001\"\n }\n ],\n \"meta\": {\n \"hasNextPage\": true,\n \"hasPreviousPage\": false,\n \"nextCursor\": \"eyJzIjoiMTIiLCJpIjoiMTIifQ==\",\n \"previousCursor\": null,\n \"limit\": 1\n },\n \"status\": 200\n}" }, { "name": "Invalid Sort Key Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:vaultId?cursor=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{vaultId}}" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"sort key must be one of the values in id,amount,dollarAmount,fees\",\n \"errors\": {\n \"message\": \"sort key must be one of the values in id,amount,dollarAmount,fees\",\n \"sortKey\": [\n \"sort key must be one of the values in id,amount,dollarAmount,fees\"\n ]\n },\n \"code\": \"E42200\"\n}" }, { "name": "Invalid Order Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:vaultId?cursor=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{vaultId}}" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"Invalid value for property 'order'. It should be one of these values: ASC, DESC\",\n \"errors\": {\n \"message\": \"Invalid value for property 'order'. It should be one of these values: ASC, DESC\",\n \"order\": [\n \"Invalid value for property 'order'. It should be one of these values: ASC, DESC\"\n ]\n },\n \"code\": \"E42200\"\n}" }, { "name": "Invalid Filters Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/:vaultId?cursor=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "{{vaultId}}" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"filters must have valid values according to id,clientId,walletId,assetId,vaultId,gasStationCategoryId,type,status,approvalTransactionActions,createdAt,updatedAt,networkId,senderAddress,receiverAddress.\",\n \"errors\": {\n \"message\": \"filters must have valid values according to id,clientId,walletId,assetId,vaultId,gasStationCategoryId,type,status,approvalTransactionActions,createdAt,updatedAt,networkId,senderAddress,receiverAddress.\",\n \"filters\": [\n \"filters must have valid values according to id,clientId,walletId,assetId,vaultId,gasStationCategoryId,type,status,approvalTransactionActions,createdAt,updatedAt,networkId,senderAddress,receiverAddress.\"\n ]\n },\n \"code\": \"E42200\"\n}" } ] }, { "name": "Get Fees Categories transactions", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/fees-categories?cursor=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "fees-categories" ], "query": [ { "key": "cursor", "value": "", "description": "Cursor for pagination.", "disabled": false }, { "key": "limit", "value": "", "description": "Number of results per page.", "disabled": false }, { "key": "sortKey", "value": "", "description": "Sort results by id, amount, dollarAmount, fees.", "disabled": false }, { "key": "order", "value": "", "description": "Sort order: 'ASC' or 'DESC'.", "disabled": false }, { "key": "search", "value": "", "description": "Search by senderAddress, receiverAddress.", "disabled": false }, { "key": "filters", "value": "", "description": "Filters results. Can include gasStationCategoryId or systemFeesCategoryId.", "disabled": false } ] }, "description": "Retrieves transactions specifically identified as system fees or gas station fees (non-vault transactions). This endpoint returns transactions where vaultId is null." }, "response": [ { "name": "Fees Categories transactions Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/transactions/fees-categories?cursor=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "fees-categories" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"fees categories transactions\",\n \"data\": [],\n \"meta\": {\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"nextCursor\": null,\n \"previousCursor\": null,\n \"limit\": 10\n },\n \"status\": 200\n}" } ] } ], "description": "Create and manage blockchain transactions. Send cryptocurrencies and tokens from client wallets to external addresses or between clients in RoxCustody. Track transaction status and history with comprehensive filtering options. Transactions support various types including incoming, outgoing, internal transfers, swaps, and allowance operations. Monitor transaction statuses from pending to completed, rejected, or error states." }, { "name": "Assets", "item": [ { "name": "Get Asset Price", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/assets/price/:assetId", "host": [ "{{baseUrl}}" ], "path": [ "assets", "price", "{{assetId}}" ], "variable": [ { "key": "assetId", "value": "{{assetId}}", "description": "assetId parameter" } ] }, "description": "Returns the current price of a specific asset." }, "response": [ { "name": "Asset Price Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/assets/price/:assetId", "host": [ "{{baseUrl}}" ], "path": [ "assets", "price", "{{assetId}}" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"asset price\",\n \"data\": {\n \"price\": 4206.88\n },\n \"status\": 201\n}" }, { "name": "Asset Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/assets/price/:assetId", "host": [ "{{baseUrl}}" ], "path": [ "assets", "price", "{{assetId}}" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Price for asset with id -1 not found\",\n \"errors\": {\n \"message\": \"Price for asset with id -1 not found\"\n },\n \"code\": \"E40406\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/assets/price/:assetId", "host": [ "{{baseUrl}}" ], "path": [ "assets", "price", "{{assetId}}" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Validation failed (numeric string is expected)\",\n \"errors\": {\n \"message\": \"Validation failed (numeric string is expected)\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n },\n \"code\": \"E40000\"\n}" } ] } ], "description": "Manage and query digital assets. Assets represent cryptocurrencies and tokens supported by the RoxCustody platform. Each asset is associated with a blockchain network and includes details such as symbol, decimals, contract address, and current pricing information. Query asset prices and view asset configurations for your vault." }, { "name": "Tokens", "item": [ { "name": "Get Token Supported Networks", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/supported-networks", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "supported-networks" ] }, "description": "Returns the list of token networks supported for the current admin." }, "response": [ { "name": "Supported Networks Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/supported-networks", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "supported-networks" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"tokenNetworks\",\n \"data\": [\n {\n \"network\": {\n \"id\": 17,\n \"name\": \"Solana\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/solana.png\"\n },\n \"types\": [\n { \"type\": 2, \"name\": \"TOKEN\" },\n { \"type\": 3, \"name\": \"ERC20\" }\n ]\n },\n {\n \"network\": {\n \"id\": 18,\n \"name\": \"Solana Devnet\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/solana.png\"\n },\n \"types\": [\n { \"type\": 2, \"name\": \"FUNGIBLE\" },\n { \"type\": 3, \"name\": \"NFT\" }\n ]\n }\n ],\n \"status\": 200\n}" } ] }, { "name": "Create Token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] }, "description": "Creates a new security token on the specified blockchain network. This endpoint uploads the image, stores metadata, and prepares the token for deployment.", "body": { "mode": "raw", "raw": "{\n \"networkId\": 28,\n \"name\": \"Sample Token\",\n \"symbol\": \"SMT\",\n \"image\": \"file\",\n \"ownerAddress\": \"A51iQm72KSwsYVrFaPye8HDo1nJUGjKaYGStKEQo4gaw\",\n \"recipientAddress\": \"A51iQm72KSwsYVrFaPye8HDo1nJUGjKaYGStKEQo4gaw\",\n \"initialSupply\": 1000,\n \"decimals\": 3,\n \"type\": 2,\n \"idempotencyKey\": \"unique-key\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Token Created Successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Security token created successfully\",\n \"data\": {\n \"id\": 3,\n \"networkId\": 18,\n \"gasStationCategoryId\": 1,\n \"name\": \"Sample Token\",\n \"symbol\": \"SMT\",\n \"decimals\": 0,\n \"fees\": null,\n \"contractAddress\": null,\n \"assetId\": null,\n \"vaultId\": 16,\n \"ownerAddress\": \"2ZqvKiMvaTYRDoZYgsmJ3ykh6XzeSYsEDivgjPgiFSaU\",\n \"recipientAddress\": \"A51iQm72KSwsYVrFaPye8HDo1nJUGjKaYGStKEQo4gaw\",\n \"config\": {\n \"metadataUrl\": \"https://custody-dev-public.s3.amazonaws.com/sample_token_1757328126036.json\"\n },\n \"verificationMessage\": null,\n \"image\": \"https://custody-dev-public.s3.amazonaws.com/صورتي_1757328124987.jpg\",\n \"network\": {\n \"id\": 28,\n \"name\": \"Rox Chain\",\n \"symbol\": \"ROX\",\n \"createdAt\": \"07 September, 2025 10:04:58\",\n \"updatedAt\": \"07 September, 2025 10:04:58\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\n \"category\": \"Solana\"\n },\n \"createdAt\": \"08 September, 2025 10:42:06\",\n \"updatedAt\": \"08 September, 2025 10:42:06\",\n \"type\": \"Token\",\n \"status\": \"PENDING\",\n \"verificationStatus\": \"PENDING\",\n \"tokenExplorerUrl\": null,\n \"initialSupply\": \"1\"\n },\n \"status\": 201\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"Error in provided data\",\n \"errors\": {\n \"initialSupply\": [\"Initial supply must be greater than or equal to 0\"]\n },\n \"code\": \"E42200\"\n}" }, { "name": "Unsupported Network", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Network is not supported\",\n \"code\": \"E40000\"\n}" }, { "name": "Vault not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Vault not found\",\n \"errors\": {\n \"message\": \"Vault not found\"\n },\n \"code\": \"E40404\"\n}" }, { "name": "Wallet not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Can't find wallet with networkId: 123 for client 123 in vault 123\",\n \"errors\": {\n \"message\": \"Can't find wallet with networkId: 123 for client 123 in vault 123\"\n },\n \"code\": \"E40403\"\n}" } ] }, { "name": "Get Token by ID", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "id parameter" } ] }, "description": "Fetches detailed information about a specific token by its ID." }, "response": [ { "name": "Token Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"token\",\n \"data\": {\n \"id\": 3,\n \"networkId\": 18,\n \"gasStationCategoryId\": 1,\n \"name\": \"SAMPLE Token\",\n \"symbol\": \"SAM\",\n \"decimals\": 3,\n \"fees\": \"15000\",\n \"contractAddress\": \"CqLkwwqZNuRhWUfGLUowgPvYUDNy5GMMKdFxhr45U3hv\",\n \"assetId\": null,\n \"vaultId\": 16,\n \"ownerAddress\": \"6kU7syaT8RSEwdUajNGyBVKWLnHzu6xyeYQ3hcxc5din\",\n \"recipientAddress\": \"2zy7WzAAUrvXZ9xDZpCYDtTV5ptrzyVWjLynnRBbuwce\",\n \"config\": {\n \"metadataUrl\": \"https://custody-dev-public.s3.amazonaws.com/sample_token_1757922441861.json\"\n },\n \"verificationMessage\": null,\n \"image\": null,\n \"network\": {\n \"id\": 18,\n \"name\": \"Solana Devnet\",\n \"symbol\": \"SOL\",\n \"createdAt\": \"14 May, 2025 12:16:46\",\n \"updatedAt\": \"14 May, 2025 12:16:46\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"http://localhost:5000/public/files/assets/solana.png\",\n \"isSwappable\": false,\n \"category\": \"Solana\",\n \"chain\": {\n \"id\": 245022926,\n \"name\": \"Solana Devnet\",\n \"nativeCurrency\": {\n \"name\": \"Solana Devnet\",\n \"symbol\": \"SOL\",\n \"decimals\": 9\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [],\n \"webSocket\": []\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Solscan\",\n \"url\": \"https://solscan.io\",\n \"apiUrl\": \"https://api.devnet.solana.com\"\n }\n }\n }\n },\n \"createdAt\": \"15 September, 2025 07:47:26\",\n \"updatedAt\": \"15 September, 2025 07:47:28\",\n \"type\": \"TOKEN\",\n \"status\": \"DEPLOYED\",\n \"verificationStatus\": \"VERIFIED\",\n \"tokenExplorerUrl\": \"https://solscan.io/account/CqLkwwqZNuRhWUfGLUowgPvYUDNy5GMMKdFxhr45U3hv?cluster=devnet\",\n \"initialSupply\": \"1000\"\n },\n \"status\": 200\n}" }, { "name": "Token Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"This token doesn't exist or not accessible.\",\n \"errors\": {\n \"message\": \"This token doesn't exist or not accessible.\"\n },\n \"code\": \"E40407\"\n}" } ] }, { "name": "Get Tokens", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token?search=&filters[networkId]=&clientId=&page=1&order=DESC&sortKey=id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ], "query": [ { "key": "search", "value": "", "description": "Search by token name or symbol", "disabled": false }, { "key": "filters[networkId]", "value": "", "description": "Filter by network ID", "disabled": false }, { "key": "clientId", "value": "", "description": "Filter by Client ID.", "disabled": false }, { "key": "page", "value": 1, "description": "Page number for pagination", "disabled": false }, { "key": "order", "value": "DESC", "description": "Sort order (ASC or DESC)", "disabled": false }, { "key": "sortKey", "value": "id", "description": "Field used to sort the results (e.g., id, name, createdAt)", "disabled": false } ] }, "description": "Retrieves a paginated list of security tokens with optional search, filtering, and sorting." }, "response": [ { "name": "Tokens Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token?search=&filters[networkId]=&clientId=&page=1&order=DESC&sortKey=id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Security tokens\",\n \"data\": [\n {\n \"id\": 143,\n \"networkId\": 28,\n \"gasStationCategoryId\": 2,\n \"name\": \"Sample Token\",\n \"symbol\": \"SMT\",\n \"decimals\": 0,\n \"fees\": \"15000\",\n \"contractAddress\": \"8hPLkzE2A6AHns7aB2EFLZrkeNS39FPDo5GvVgh1ij6b\",\n \"assetId\": 4148,\n \"vaultId\": 4,\n \"ownerAddress\": \"2ZqvKiMvaTYRDoZYgsmJ3ykh6XzeSYsEDivgjPgiFSaU\",\n \"recipientAddress\": \"A51iQm72KSwsYVrFaPye8HDo1nJUGjKaYGStKEQo4gaw\",\n \"config\": {\n \"additional\": { \"description\": \"This is a Sample Token\" },\n \"metadataUrl\": \"https://custody-dev-public.s3.amazonaws.com/sample_token_1757322125713.json\"\n },\n \"verificationMessage\": null,\n \"image\": \"https://custody-dev-public.s3.amazonaws.com/صورتي_1757322124788.jpg\",\n \"network\": {\n \"id\": 28,\n \"name\": \"Rox Chain\",\n \"symbol\": \"ROX\",\n \"createdAt\": \"07 September, 2025 10:04:58\",\n \"updatedAt\": \"07 September, 2025 10:04:58\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\n \"isSwappable\": false,\n \"category\": \"Solana\"\n },\n \"createdAt\": \"08 September, 2025 09:02:06\",\n \"updatedAt\": \"08 September, 2025 09:02:12\",\n \"type\": \"NFT\",\n \"status\": \"DEPLOYED\",\n \"verificationStatus\": \"VERIFIED\",\n \"tokenExplorerUrl\": \"https://roxscan.roxcustody.io/address/8hPLkzE2A6AHns7aB2EFLZrkeNS39FPDo5GvVgh1ij6b\",\n \"initialSupply\": \"1\"\n }\n ],\n \"meta\": {\n \"totalItems\": 1,\n \"itemsPerPage\": 10,\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n },\n \"status\": 200\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token?search=&filters[networkId]=&clientId=&page=1&order=DESC&sortKey=id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Invalid query parameters\",\n \"errors\": {\n \"message\": \"Invalid query parameters\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n },\n \"code\": \"E40000\"\n}" }, { "name": "Client not found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token?search=&filters[networkId]=&clientId=&page=1&order=DESC&sortKey=id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Client not found in this vault\",\n \"errors\": {\n \"message\": \"Client not found in this vault\"\n},\n \"code\": \"E40402\"\n}" } ] }, { "name": "Mint Tokens", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/mint", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "mint" ] }, "description": "Mints new security tokens with specified parameters and metadata.", "body": { "mode": "raw", "raw": "{\n \"assetId\": 2298,\n \"recipientAddress\": \"DETbUZDD6kysjw5d5LxYsw63zDsN7R1Q1cAETNKzcpMm\",\n \"amount\": \"500\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Security token mint transaction has been created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/mint", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "mint" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Security token mint transaction has been created successfully\",\n \"data\": {\n \"transactionId\": 5\n},\n \"status\": 200\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/mint", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "mint" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Only one of clientId, recipientAddress, or master wallet target can be provided\",\n \"code\": \"E40000\"\n}" }, { "name": "Client Wallet Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/mint", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "mint" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Can't find wallet for this client\",\n \"errors\": {\n \"message\": \"Can't find wallet for this client\"\n },\n \"code\": \"E40403\"\n}" }, { "name": "Asset Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/mint", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "mint" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"No coin asset found for this network\",\n \"errors\": {\n \"message\": \"No coin asset found for this network\"\n},\n \"code\": \"E40408\"\n}" }, { "name": "Master Wallet Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/mint", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "mint" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":404,\"message\":\"Master wallet not found\",\"errors\":{\"message\":\"Master wallet not found\"},\"code\":\"E40403\"}" } ] }, { "name": "Burn Tokens", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/burn", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "burn" ] }, "description": "Burns new security tokens with specified parameters and metadata.", "body": { "mode": "raw", "raw": "{\n \"assetId\": 2298,\n \"recipientAddress\": \"DETbUZDD6kysjw5d5LxYsw63zDsN7R1Q1cAETNKzcpMm\",\n \"amount\": \"500\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Security token burn transaction has been created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/burn", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "burn" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Security token burn transaction has been created successfully\",\n \"data\": {\n \"transactionId\": 5\n},\n \"status\": 200\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/burn", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "burn" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Only one of clientId, recipientAddress, or master wallet target can be provided\",\n \"code\": \"E40000\"\n}" }, { "name": "Client Wallet Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/burn", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "burn" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Can't find wallet for this client\",\n \"errors\": {\n \"message\": \"Can't find wallet for this client\"\n },\n \"code\": \"E40403\"\n}" }, { "name": "Asset Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/burn", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "burn" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"No coin asset found for this network\",\n \"errors\": {\n \"message\": \"No coin asset found for this network\"\n},\n \"code\": \"E40408\"\n}" }, { "name": "Master Wallet Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/burn", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "burn" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":404,\"message\":\"Master wallet not found\",\"errors\":{\"message\":\"Master wallet not found\"},\"code\":\"E40403\"}" } ] }, { "name": "Update Token Metadata", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}", "metadata" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "id parameter" } ] }, "description": "Updates the metadata of a deployed security token. The metadata file stored in S3 is retrieved, merged with the new metadata fields, and re-uploaded.", "body": { "mode": "raw", "raw": "{\n \"additional\": {\n \"description\": \"This is a test token\",\n \"website\": \"https://example.com\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Metadata Updated Successfully", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}", "metadata" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Metadata updated successfully\",\n \"status\": 200\n}" }, { "name": "Token Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}", "metadata" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"This token doesn't exist or not accessible.\",\n \"errors\": {\n \"message\": \"This token doesn't exist or not accessible.\"\n },\n \"code\": \"E40407\"\n}" }, { "name": "Token Not Deployed", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}", "metadata" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Token is not in deployed status\",\n \"errors\": {\n \"message\": \"Token is not in deployed status\"\n },\n \"code\": \"E40009\"\n}" }, { "name": "Metadata URL Missing", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}", "metadata" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Metadata url is not defined\",\n \"errors\": {\n \"message\": \"Metadata url is not defined\"\n },\n \"code\": \"E40010\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/token/:id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "token", "{{id}}", "metadata" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"Error in provided data\",\n \"errors\": {\n \"additional\": [\"additional must be an object with string values only\"]\n },\n \"code\": \"E42200\"\n}" } ] } ], "description": "Manage security tokens and tokenized assets. Create, deploy, and manage fungible tokens on supported blockchains in RoxCustody. Tokenization allows you to represent real-world assets or create new digital assets as blockchain tokens. View token details, supported networks, create tokens, mint or burn tokens, and manage token metadata. Tokens can be transferred between wallets and integrated into your custody operations." }, { "name": "NFTs", "item": [ { "name": "Get NFT Supported Networks", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/supported-networks", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "supported-networks" ] }, "description": "Returns the list of NFT networks supported for the current admin." }, "response": [ { "name": "Supported Networks Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/supported-networks", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "supported-networks" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"nftNetworks\",\n \"data\": [\n {\n \"network\": {\n \"id\": 17,\n \"name\": \"Solana\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/solana.png\"\n },\n \"types\": [\n { \"type\": 2, \"name\": \"FUNGIBLE\" },\n { \"type\": 3, \"name\": \"NFT\" }\n ]\n },\n {\n \"network\": {\n \"id\": 18,\n \"name\": \"Solana Devnet\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/solana.png\"\n },\n \"types\": [\n { \"type\": 2, \"name\": \"FUNGIBLE\" },\n { \"type\": 3, \"name\": \"NFT\" }\n ]\n }\n ],\n \"status\": 200\n}" } ] }, { "name": "Create NFT Token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] }, "description": "Creates a new NFT security token on the specified blockchain network. This endpoint uploads the image, stores metadata, and prepares the token for deployment.", "body": { "mode": "raw", "raw": "{\n \"networkId\": 28,\n \"name\": \"Sample Token\",\n \"symbol\": \"SMT\",\n \"ownerAddress\": \"A51iQm72KSwsYVrFaPye8HDo1nJUGjKaYGStKEQo4gaw\",\n \"idempotencyKey\": \"unique-key\",\n \"additional\": {\n \"description\": \"This is a Sample Token\",\n \"key_1\": \"value 1\",\n \"key_2\": \"value 2\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "NFT Token Created Successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Security token created successfully\",\n \"data\": {\n \"childrenCount\": 0,\n \"id\": 146,\n \"networkId\": 28,\n \"gasStationCategoryId\": 2,\n \"name\": \"Sample Token\",\n \"symbol\": \"SMT\",\n \"decimals\": 0,\n \"fees\": null,\n \"contractAddress\": null,\n \"assetId\": null,\n \"vaultId\": 4,\n \"ownerAddress\": \"2ZqvKiMvaTYRDoZYgsmJ3ykh6XzeSYsEDivgjPgiFSaU\",\n \"recipientAddress\": \"A51iQm72KSwsYVrFaPye8HDo1nJUGjKaYGStKEQo4gaw\",\n \"config\": {\n \"additional\": { \"description\": \"This is a Sample Token\" },\n \"metadataUrl\": \"https://custody-dev-public.s3.amazonaws.com/sample_token_1757328126036.json\"\n },\n \"verificationMessage\": null,\n \"image\": \"https://custody-dev-public.s3.amazonaws.com/صورتي_1757328124987.jpg\",\n \"network\": {\n \"id\": 28,\n \"name\": \"Rox Chain\",\n \"symbol\": \"ROX\",\n \"createdAt\": \"07 September, 2025 10:04:58\",\n \"updatedAt\": \"07 September, 2025 10:04:58\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\n \"category\": \"Solana\"\n },\n \"parent\": null,\n \"createdAt\": \"08 September, 2025 10:42:06\",\n \"updatedAt\": \"08 September, 2025 10:42:06\",\n \"type\": \"NFT\",\n \"status\": \"PENDING\",\n \"isCollection\": \"false\",\n \"verificationStatus\": \"PENDING\",\n \"tokenExplorerUrl\": null,\n \"initialSupply\": \"1\"\n },\n \"status\": 201\n}" }, { "name": "Vault not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Vault not found\",\n \"errors\": {\n \"message\": \"Vault not found\"\n },\n \"code\": \"E40404\"\n}" }, { "name": "Wallet not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Can't find wallet with networkId: 123 for client 123 in vault 123\",\n \"errors\": {\n \"message\": \"Can't find wallet with networkId: 123 for client 123 in vault 123\"\n },\n \"code\": \"E40403\"\n}" }, { "name": "Coin asset not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"No coin asset found for this network\",\n \"errors\": {\n \"message\": \"No coin asset found for this network\"\n},\n \"code\": \"E40408\"\n}" }, { "name": "Category not supported", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Category not supported\",\n \"code\": \"E40000\"\n}" } ] }, { "name": "Get NFT Token by ID", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "id parameter" } ] }, "description": "Fetches detailed information about a specific NFT token by its ID." }, "response": [ { "name": "NFT Token Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"token\",\n \"data\": {\n \"childrenCount\": 0,\n \"id\": 143,\n \"networkId\": 28,\n \"gasStationCategoryId\": 2,\n \"name\": \"Sample Token\",\n \"symbol\": \"SMT\",\n \"decimals\": 0,\n \"fees\": \"15000\",\n \"contractAddress\": \"8hPLkzE2A6AHns7aB2EFLZrkeNS39FPDo5GvVgh1ij6b\",\n \"assetId\": 4148,\n \"vaultId\": 4,\n \"ownerAddress\": \"2ZqvKiMvaTYRDoZYgsmJ3ykh6XzeSYsEDivgjPgiFSaU\",\n \"recipientAddress\": \"A51iQm72KSwsYVrFaPye8HDo1nJUGjKaYGStKEQo4gaw\",\n \"config\": {\n \"additional\": {\n \"description\": \"This is a Sample Token\"\n },\n \"metadataUrl\": \"https://custody-dev-public.s3.amazonaws.com/sample_token_1757322125713.json\"\n },\n \"verificationMessage\": null,\n \"image\": \"https://custody-dev-public.s3.amazonaws.com/صورتي_1757322124788.jpg\",\n \"network\": {\n \"id\": 28,\n \"name\": \"Rox Chain\",\n \"symbol\": \"ROX\",\n \"createdAt\": \"07 September, 2025 10:04:58\",\n \"updatedAt\": \"07 September, 2025 10:04:58\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\n \"isSwappable\": false,\n \"category\": \"Solana\",\n \"chain\": {\n \"id\": 245022934,\n \"name\": \"Rox Chain\",\n \"nativeCurrency\": {\n \"name\": \"Rox\",\n \"symbol\": \"ROX\",\n \"decimals\": 9\n },\n \"rpcUrls\": {\n \"default\": {\n \"http\": [],\n \"webSocket\": []\n }\n },\n \"blockExplorers\": {\n \"default\": {\n \"name\": \"Rox chain explorer\",\n \"url\": \"https://roxscan.roxcustody.io\",\n \"apiUrl\": \"http://91.99.236.35:8899\"\n }\n }\n }\n },\n \"parent\": null,\n \"createdAt\": \"08 September, 2025 09:02:06\",\n \"updatedAt\": \"08 September, 2025 09:02:12\",\n \"type\": \"NFT\",\n \"status\": \"DEPLOYED\",\n \"verificationStatus\": \"VERIFIED\",\n \"tokenExplorerUrl\": \"https://roxscan.roxcustody.io/address/8hPLkzE2A6AHns7aB2EFLZrkeNS39FPDo5GvVgh1ij6b\",\n \"isCollection\": \"false\",\n \"initialSupply\": \"1\"\n },\n \"status\": 200\n}" }, { "name": "Token Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"This token doesn't exist or not accessible.\",\n \"errors\": {\n \"message\": \"This token doesn't exist or not accessible.\"\n },\n \"code\": \"E40407\"\n}" } ] }, { "name": "Get NFT Tokens", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft?search=&filters[networkId]=&page=1&order=DESC&sortKey=id&clientId=", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ], "query": [ { "key": "search", "value": "", "description": "Search by token name or symbol", "disabled": false }, { "key": "filters[networkId]", "value": "", "description": "Filter by network ID", "disabled": false }, { "key": "page", "value": 1, "description": "Page number for pagination", "disabled": false }, { "key": "order", "value": "DESC", "description": "Sort order (ASC or DESC)", "disabled": false }, { "key": "sortKey", "value": "id", "description": "Field used to sort the results (e.g., id, name, createdAt)", "disabled": false }, { "key": "clientId", "value": "", "description": "Filter by Client ID.", "disabled": false } ] }, "description": "Retrieves a paginated list of NFT security tokens with optional search, filtering, and sorting." }, "response": [ { "name": "NFT Tokens Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft?search=&filters[networkId]=&page=1&order=DESC&sortKey=id&clientId=", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Security tokens\",\n \"data\": [\n {\n \"id\": 143,\n \"networkId\": 28,\n \"gasStationCategoryId\": 2,\n \"name\": \"Sample Token\",\n \"symbol\": \"SMT\",\n \"decimals\": 0,\n \"fees\": \"15000\",\n \"contractAddress\": \"8hPLkzE2A6AHns7aB2EFLZrkeNS39FPDo5GvVgh1ij6b\",\n \"assetId\": 4148,\n \"vaultId\": 4,\n \"ownerAddress\": \"2ZqvKiMvaTYRDoZYgsmJ3ykh6XzeSYsEDivgjPgiFSaU\",\n \"recipientAddress\": \"A51iQm72KSwsYVrFaPye8HDo1nJUGjKaYGStKEQo4gaw\",\n \"config\": {\n \"additional\": { \"description\": \"This is a Sample Token\" },\n \"metadataUrl\": \"https://custody-dev-public.s3.amazonaws.com/sample_token_1757322125713.json\"\n },\n \"verificationMessage\": null,\n \"image\": \"https://custody-dev-public.s3.amazonaws.com/صورتي_1757322124788.jpg\",\n \"network\": {\n \"id\": 28,\n \"name\": \"Rox Chain\",\n \"symbol\": \"ROX\",\n \"createdAt\": \"07 September, 2025 10:04:58\",\n \"updatedAt\": \"07 September, 2025 10:04:58\",\n \"type\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"logo\": \"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\n \"isSwappable\": false,\n \"category\": \"Solana\"\n },\n \"createdAt\": \"08 September, 2025 09:02:06\",\n \"updatedAt\": \"08 September, 2025 09:02:12\",\n \"type\": \"NFT\",\n \"status\": \"DEPLOYED\",\n \"verificationStatus\": \"VERIFIED\",\n \"tokenExplorerUrl\": \"https://roxscan.roxcustody.io/address/8hPLkzE2A6AHns7aB2EFLZrkeNS39FPDo5GvVgh1ij6b\",\n \"initialSupply\": \"1\"\n }\n ],\n \"meta\": {\n \"totalItems\": 1,\n \"itemsPerPage\": 10,\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n },\n \"status\": 200\n}" }, { "name": "Client not found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft?search=&filters[networkId]=&page=1&order=DESC&sortKey=id&clientId=", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Client not found in this vault\",\n \"errors\": {\n \"message\": \"Client not found in this vault\"\n},\n \"code\": \"E40402\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft?search=&filters[networkId]=&page=1&order=DESC&sortKey=id&clientId=", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Invalid query parameters\",\n \"errors\": {\n \"message\": \"Invalid query parameters\",\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n },\n \"code\": \"E40000\"\n}" } ] }, { "name": "Transfer NFT Token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}", "transfer" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "id parameter" } ] }, "description": "Transfers ownership of a deployed NFT token to another wallet address on the same blockchain network.", "body": { "mode": "raw", "raw": "{\n \"recipientAddress\": \"8fgxN5w32YSQZvURvhx1jPM7bRQXyYosFq3fsTLKSL3z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "NFT transfer transaction has been created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}", "transfer" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"NFT transfer transaction has been created successfully\",\n \"data\": {\n \"transactionId\": 101\n },\n \"status\": 200\n}" }, { "name": "NFT Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}", "transfer" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Security token not found\",\n \"errors\": {\n \"message\": \"Security token not found\",\n \"error\": \"Not Found\",\n \"statusCode\": 404\n},\n \"code\": \"E40400\"\n}" }, { "name": "No Coin Asset Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}", "transfer" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"No coin asset found for this network\",\n \"errors\": {\n \"message\": \"No coin asset found for this network\"\n},\n \"code\": \"E40408\"\n}" }, { "name": "Invalid Transfer Conditions", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}", "transfer" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Token is not in deployed status\",\n \"errors\": {\n \"message\": \"Token is not in deployed status\"\n },\n \"code\": \"E40009\"\n}" }, { "name": "Invalid Recipient Address", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}", "transfer" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"Invalid recipient address\",\n \"code\": \"E40000\"\n}" }, { "name": "Vault Mismatch Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}", "transfer" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 400,\n \"message\": \"NFT is not in vault 4\",\n \"code\": \"E40000\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/tokenization/nft/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "tokenization", "nft", "{{id}}", "transfer" ] } }, "status": "422", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 422,\n \"message\": \"Error in provided data\",\n \"errors\": {\n \"recipientAddress\": [\"The address provided is not a valid EVM, BitCoin, BitcoinTest, Tron, Solana, Xrp, Polkadot, Stellar or RoxChain address\"]\n },\n \"code\": \"E42200\"\n}" } ] } ], "description": "Manage Non-Fungible Tokens (NFTs). Create, deploy, and manage unique digital assets as NFTs on supported blockchains in RoxCustody. NFTs represent unique items such as digital art, collectibles, or certificates of ownership. View NFT details, supported networks, create NFTs, transfer NFTs between wallets, and track NFT transfer transactions. Each NFT has unique metadata and ownership information." }, { "name": "Payment Vault Order", "item": [ { "name": "Create Payment Vault Order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders" ] }, "description": "Creates a new payment vault order for processing crypto payments. The order will be created with PENDING status and a payment link will be generated.", "body": { "mode": "raw", "raw": "{\n \"amountInFiat\": 100,\n \"id\": \"order-123\",\n \"clientName\": \"John Doe\",\n \"itemName\": \"Product Purchase\",\n \"assetId\": 2169,\n \"email\": \"customer@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Payment Vault Order Created Successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\":\"Payment vault order created successfully\",\"data\":{\"id\":\"order-123\",\"vaultId\":13,\"clientName\":\"JohnDoe\",\"itemName\":\"ProductPurchase\",\"status\":\"PENDING\",\"amountInDollar\":\"100\",\"amountInFiat\":100,\"email\":\"customer@example.com\",\"walletId\":32,\"wallet\":{\"id\":32,\"balance\":\"0\",\"publicAddress\":\"FCHshXgJJGF1H3G5JWnzjLuFWw39v3ViMALrxt21BrvU\",\"asset\":{\"id\":2169,\"networkId\":28,\"pricingId\":\"rox\",\"name\":\"Rox\",\"symbol\":\"ROX\",\"contractAddress\":null,\"decimals\":9,\"network\":{\"id\":28,\"name\":\"RoxChain\",\"symbol\":\"ROX\",\"createdAt\":\"23December,202514:24:14\",\"updatedAt\":\"23December,202514:24:14\",\"type\":\"PUBLIC\",\"status\":\"ACTIVE\",\"logo\":\"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\"isSwappable\":false,\"category\":\"Solana\",\"chain\":{\"id\":245022934,\"name\":\"RoxChain\",\"nativeCurrency\":{\"name\":\"Rox\",\"symbol\":\"ROX\",\"decimals\":9},\"rpcUrls\":{\"default\":{\"http\":[],\"webSocket\":[]}},\"blockExplorers\":{\"default\":{\"name\":\"Roxchainexplorer\",\"url\":\"https://explorer.roxchain.io\",\"apiUrl\":\"https://rpc.roxchain.io\"}}}},\"createdAt\":\"23December,202514:24:14\",\"updatedAt\":\"23December,202514:24:14\",\"vaultStatus\":\"active\",\"isHidden\":false,\"type\":\"COIN\",\"status\":\"ACTIVE\",\"logo\":\"https://api-admin.roxcustody.io/public/files/assets/rox.svg\"}},\"asset\":{\"id\":2169,\"networkId\":28,\"pricingId\":\"rox\",\"name\":\"Rox\",\"symbol\":\"ROX\",\"contractAddress\":null,\"decimals\":9,\"network\":{\"id\":28,\"name\":\"RoxChain\",\"symbol\":\"ROX\",\"createdAt\":\"23December,202514:24:14\",\"updatedAt\":\"23December,202514:24:14\",\"type\":\"PUBLIC\",\"status\":\"ACTIVE\",\"logo\":\"https://api-admin.roxcustody.io/public/files/assets/rox.svg\",\"isSwappable\":false,\"category\":\"Solana\",\"chain\":{\"id\":245022934,\"name\":\"RoxChain\",\"nativeCurrency\":{\"name\":\"Rox\",\"symbol\":\"ROX\",\"decimals\":9},\"rpcUrls\":{\"default\":{\"http\":[],\"webSocket\":[]}},\"blockExplorers\":{\"default\":{\"name\":\"Roxchainexplorer\",\"url\":\"https://explorer.roxchain.io\",\"apiUrl\":\"https://rpc.roxchain.io\"}}}},\"createdAt\":\"23December,202514:24:14\",\"updatedAt\":\"23December,202514:24:14\",\"vaultStatus\":\"active\",\"isHidden\":false,\"type\":\"COIN\",\"status\":\"ACTIVE\",\"logo\":\"https://api-admin.roxcustody.io/public/files/assets/rox.svg\"},\"createdAt\":\"2025-12-28T13:51:49.011Z\",\"updatedAt\":\"2025-12-28T13:51:49.011Z\",\"balance\":\"0\",\"paymentLink\":\"roxcustody.com/orders/01KDJTH8FTDXBERQ6DQSAN3F48\",\"globalId\":\"01KDJTH8FTDXBERQ6DQSAN3F48\",\"amountInAsset\":\"100\",\"expiration\":\"2026-02-18T12:53:47.990Z\"},\"status\":201}" }, { "name": "Order ID Already Exists", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":400,\"message\":\"order number already exists\",\"errors\":{\"message\":\"order number already exists\"},\"code\":\"E42202\"}" }, { "name": "Asset Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Asset not found\",\n \"errors\": {\n \"message\": \"Asset not found\"\n},\n \"code\": \"E40408\"\n}" }, { "name": "Amount Below Minimum", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":400,\"message\":\"Amount must be greater than or equal to 0.5\",\"errors\":{\"message\":\"Amount must be greater than or equal to 0.5\",\"error\":\"Bad Request\",\"statusCode\":400},\"code\":\"E40000\"}" }, { "name": "Wallet not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":404,\"message\":\"Wallet not found\",\"errors\":{\"message\":\"Wallet not found\"},\"code\":\"E40403\"}" } ] }, { "name": "Select Payment Vault Order Asset", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/select-asset", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "select-asset" ] }, "description": "Selects or changes the cryptocurrency asset for an existing payment order. This assigns a new wallet and recalculates the amount in the selected asset.", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"order-123\",\n \"assetId\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Asset Selected Successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/select-asset", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "select-asset" ] } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\":\"Payment vault order asset selected successfully\",\"data\":{\"id\":\"order-123\",\"referentialAutoIncrementalId\":1,\"vaultId\":13,\"walletId\":34,\"clientName\":\"John Doe\",\"itemName\":\"Product Purchase\",\"status\":\"PENDING\",\"amountInDollar\":\"100.00000000000000000000\",\"amountInFiat\":\"100.00000000000000000000\",\"email\":\"customer@example.com\",\"expiration\":\"2025-12-28T17:26:57.000Z\",\"vault\":{\"gasStationCategoryId\":1,\"fiatCurrencyDetails\":{\"id\":5,\"name\":\"US Dollar\",\"symbol\":\"$\",\"pricingId\":\"usd\"},\"photo\":null},\"wallet\":{\"id\":34,\"assetId\":13,\"balance\":\"0\",\"pendingBalance\":\"0\",\"publicAddress\":\"0x8159f7C943B070C1a0c51E0a70ad86BaE08b9f2d\",\"transactionsCount\":\"0\",\"targetId\":\"5\",\"protocol\":0,\"asset\":{\"id\":1,\"networkId\":1,\"pricingId\":\"ethereum\",\"name\":\"Ether\",\"symbol\":\"ETH\",\"contractAddress\":null,\"decimals\":18,\"network\":{\"id\":1,\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"createdAt\":\"23 December, 2025 14:24:13\",\"updatedAt\":\"23 December, 2025 14:24:13\",\"type\":\"PUBLIC\",\"status\":\"ACTIVE\",\"logo\":\"https://api-admin.roxcustody.io/public/files/assets/ethereum.png\",\"isSwappable\":true,\"category\":\"EVM\",\"chain\":{\"id\":1,\"name\":\"Ethereum\",\"nativeCurrency\":{\"name\":\"Ether\",\"symbol\":\"ETH\",\"decimals\":18},\"rpcUrls\":{\"default\":{\"http\":[\"https://ethereum-rpc.publicnode.com\",\"https://eth.llamarpc.com\"]}},\"blockExplorers\":{\"default\":{\"name\":\"Etherscan\",\"url\":\"https://etherscan.io\",\"apiUrl\":\"https://api.etherscan.io/api\"}}}},\"createdAt\":\"23 December, 2025 14:24:14\",\"updatedAt\":\"24 December, 2025 11:32:51\",\"type\":\"COIN\",\"status\":\"ACTIVE\",\"logo\":\"https://api-admin.roxcustody.io/public/files/assets/ethereum.png\"},\"createdAt\":\"28 December, 2025 16:26:56\",\"updatedAt\":\"28 December, 2025 16:26:56\",\"type\":\"ORDER\"},\"amountToBeCollected\":\"0\",\"createdAt\":\"2025-12-28T13:51:49.011Z\",\"updatedAt\":\"2025-12-28T14:26:56.000Z\",\"transactions\":[],\"balance\":\"0\",\"expirationWithTolerance\":\"2025-12-28T17:26:57.000Z\",\"paymentLink\":\"roxcustody.com/orders/01KDJTH8FTDXBERQ6DQSAN3F48\",\"globalId\":\"01KDJTH8FTDXBERQ6DQSAN3F48\",\"amountInAsset\":\"0.033965083893757218\"},\"status\":201}" }, { "name": "Order Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/select-asset", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "select-asset" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":404,\"message\":\"Order not found\",\"errors\":{\"message\":\"Order not found\"},\"code\":\"E40409\"}" }, { "name": "Asset Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/select-asset", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "select-asset" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 404,\n \"message\": \"Asset not found\",\n \"errors\": {\n \"message\": \"Asset not found\"\n},\n \"code\": \"E40408\"\n}" }, { "name": "Order Not Pending", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/select-asset", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "select-asset" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":400,\"message\":\"Order is not pending\",\"errors\":{\"message\":\"Order is not pending\"},\"code\":\"E40011\"}" }, { "name": "Order already has this asset", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/select-asset", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "select-asset" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":400,\"message\":\"Order already has this asset\",\"errors\":{\"message\":\"Order already has this asset\"},\"code\":\"E40409\"}" }, { "name": "Cannot Change Asset", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/select-asset", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "select-asset" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":400,\"message\":\"You cannot change the asset of this order\",\"errors\":{\"message\":\"You cannot change the asset of this order\",\"error\":\"Bad Request\",\"statusCode\":400},\"code\":\"E40000\"}" }, { "name": "Wallet not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/select-asset", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "select-asset" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":404,\"message\":\"Wallet not found\",\"errors\":{\"message\":\"Wallet not found\"},\"code\":\"E40403\"}" } ] }, { "name": "Get Payment Vault Orders", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders?page=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders" ], "query": [ { "key": "page", "value": "", "description": "Page number for pagination", "disabled": false }, { "key": "limit", "value": "", "description": "Number of results per page", "disabled": false }, { "key": "sortKey", "value": "", "description": "Field to sort by (createdAt)", "disabled": false }, { "key": "order", "value": "", "description": "Sort order (asc or desc)", "disabled": false }, { "key": "search", "value": "", "description": "Search by order ID or expiration", "disabled": false }, { "key": "filters", "value": "", "description": "Filter criteria", "disabled": false } ] }, "description": "Retrieves all payment vault orders for the current vault with pagination and filtering support." }, "response": [ { "name": "Orders Retrieved Successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders?page=&limit=&sortKey=&order=&search=&filters=", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Payment vault orders fetched successfully\",\n \"data\": [\n {\n \"id\": \"order-123\",\n \"vaultId\": 1,\n \"status\": \"PENDING\",\n \"amountInDollar\": \"100.00\",\n \"amountInFiat\": \"100.00\",\n \"amountInAsset\": \"0.05\",\n \"clientName\": \"John Doe\",\n \"itemName\": \"Product Purchase\",\n \"email\": \"customer@example.com\",\n \"expiration\": \"2025-12-28T12:57:25.000Z\",\n \"balance\": \"0\",\n \"globalId\": \"01JGXYZ123ABC456DEF789GHI\",\n \"paymentLink\": \"https://rox.com/orders/01JGXYZ123ABC456DEF789GHI\",\n \"amountToBeCollected\": \"0\",\n \"wallet\": {\n \"id\": 123,\n \"publicAddress\": \"0x1234567890abcdef1234567890abcdef12345678\",\n \"decimals\": 18,\n \"balance\": \"0\",\n \"asset\": {\n \"id\": 1,\n \"name\": \"Ether\",\n \"symbol\": \"ETH\",\n \"network\": {\n \"id\": 1,\n \"name\": \"Ethereum\",\n \"symbol\": \"ETH\",\n \"category\": \"EVM\"\n }\n }\n },\n \"transactions\": [],\n \"createdAt\": \"2025-12-28T11:57:25.000Z\",\n \"updatedAt\": \"2025-12-28T11:57:25.000Z\"\n }\n ],\n \"meta\": {\n \"totalItems\": 50,\n \"itemsPerPage\": 10,\n \"totalPages\": 5,\n \"currentPage\": 1,\n \"hasPreviousPage\": false,\n \"hasNextPage\": true\n },\n \"status\": 200\n}" } ] }, { "name": "Get Payment Vault Order", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "{{orderId}}" ], "variable": [ { "key": "orderId", "value": "{{orderId}}", "description": "orderId parameter" } ] }, "description": "Retrieves a single payment vault order by its ID." }, "response": [ { "name": "Payment vault order fetched successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "{{orderId}}" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\":\"Payment vault order fetched successfully\",\"data\":{\"id\":\"order-123\",\"vaultId\":13,\"clientName\":\"John Doe\",\"itemName\":\"Product Purchase\",\"status\":\"PAID\",\"amountInDollar\":\"100.00000000000000000000\",\"amountInFiat\":\"100.00000000000000000000\",\"email\":\"customer@example.com\",\"expiration\":\"2025-12-28T17:26:57.000Z\",\"walletId\":\"order-123\",\"vault\":{\"id\":1,\"name\":\"Test Vault\",\"fiatCurrency\":{\"id\":5,\"name\":\"US Dollar\",\"symbol\":\"$\",\"pricingId\":\"usd\"}},\"wallet\":{\"id\":34,\"balance\":\"0\",\"pendingBalance\":\"0\",\"publicAddress\":\"0x8159f7C943B070C1a0c51E0a70ad86BaE08b9f2d\",\"transactionsCount\":\"0\",\"targetId\":\"5\",\"protocol\":0,\"asset\":{\"id\":1, \"networkId\":1,\"pricingId\":\"ethereum\",\"name\":\"Ether\",\"symbol\":\"ETH\",\"contractAddress\":null,\"decimals\":18,\"network\":{\"id\":1,\"name\":\"Ethereum\",\"symbol\":\"ETH\",\"createdAt\":\"23 December, 2025 14:24:13\",\"updatedAt\":\"23 December, 2025 14:24:13\",\"type\":\"PUBLIC\",\"status\":\"ACTIVE\",\"logo\":\"https://api-admin.roxcustody.io/public/files/assets/ethereum.png\",\"isSwappable\":true,\"category\":\"EVM\",\"chain\":{\"id\":1,\"name\":\"Ethereum\",\"nativeCurrency\":{\"name\":\"Ether\",\"symbol\":\"ETH\",\"decimals\":18},\"rpcUrls\":{\"default\":{\"http\":[\"https://ethereum-rpc.publicnode.com\",\"https://eth.llamarpc.com\"]}},\"blockExplorers\":{\"default\":{\"name\":\"Etherscan\",\"url\":\"https://etherscan.io\",\"apiUrl\":\"https://api.etherscan.io/api\"}}}},\"createdAt\":\"23 December, 2025 14:24:14\",\"updatedAt\":\"24 December, 2025 11:32:51\",\"type\":\"COIN\",\"status\":\"ACTIVE\",\"logo\":\"https://api-admin.roxcustody.io/public/files/assets/ethereum.png\"},\"createdAt\":\"28 December, 2025 16:26:56\",\"updatedAt\":\"28 December, 2025 16:26:56\",\"type\":\"ORDER\"},\"amountToBeCollected\":\"0\",\"createdAt\":\"2025-12-28T13:51:49.011Z\",\"updatedAt\":\"2025-12-28T14:37:35.168Z\",\"transactions\":[],\"balance\":\"0\",\"expirationWithTolerance\":\"2025-12-28T17:26:57.000Z\",\"paymentLink\":\"roxcustody.com/orders/01KDJTH8FTDXBERQ6DQSAN3F48\",\"globalId\":\"01KDJTH8FTDXBERQ6DQSAN3F48\",\"amountInAsset\":\"0.033965083893757218\"},\"status\":200}" }, { "name": "Order Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "{{orderId}}" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":404,\"message\":\"Order not found\",\"errors\":{\"message\":\"Order not found\"},\"code\":\"E40409\"}" } ] }, { "name": "Cancel Payment Vault Order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/:orderId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "{{orderId}}", "cancel" ], "variable": [ { "key": "orderId", "value": "{{orderId}}", "description": "orderId parameter" } ] }, "description": "Cancels a pending payment vault order. Orders with existing transactions cannot be cancelled." }, "response": [ { "name": "Order Cancelled Successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/:orderId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "{{orderId}}", "cancel" ] } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Payment vault order cancelled successfully\",\n \"status\": 200\n}" }, { "name": "Order Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/:orderId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "{{orderId}}", "cancel" ] } }, "status": "404", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":404,\"message\":\"Order not found\",\"errors\":{\"message\":\"Order not found\"},\"code\":\"E40409\"}" }, { "name": "Order Has Transactions", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/:orderId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "{{orderId}}", "cancel" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":400,\"message\":\"Cannot cancel order with transactions\",\"errors\":{\"message\":\"Cannot cancel order with transactions\"},\"code\":\"E40013\"}" }, { "name": "Order Not Pending", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-orders/:orderId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "payment-orders", "{{orderId}}", "cancel" ] } }, "status": "400", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"status\":400,\"message\":\"Order is not pending\",\"errors\":{\"message\":\"Order is not pending\"},\"code\":\"E40011\"}" } ] } ], "description": "Manage payment vault orders for processing crypto payments. Create payment orders that allow customers to pay in cryptocurrency. Each order generates a unique payment link and assigns a wallet for receiving payments. Orders can be created with a specific asset or the asset can be selected later. Track order status, view order details, and cancel pending orders. Payment orders support fiat amount conversion and automatic wallet assignment." } ], "variable": [ { "key": "baseUrl", "value": "https://api.roxcustody.io", "type": "string" }, { "key": "X-ACCESS-TOKEN", "value": "YOUR-ACCESS-TOKEN", "type": "string" } ] }