{ "openapi": "3.0.3", "servers": [ { "url": "https://rest.vaultody.com", "description": "REST API" } ], "components": { "securitySchemes": { "ApiKey": { "name": "x-api-key", "description": "cb233681a8ee35665296c1824c1f67bc46691788", "type": "apiKey", "in": "header" }, "ApiSign": { "name": "x-api-sign", "description": "PSqeqRLap8rBc/wogNU1DeGGUPb2VyVtg6GiBOaBnYQ=", "type": "apiKey", "in": "header" }, "ApiTimestamp": { "name": "x-api-timestamp", "description": "1681885776", "type": "apiKey", "in": "header" }, "ApiPassphrase": { "name": "x-api-passphrase", "description": "zYgKeueoOq", "type": "apiKey", "in": "header" } }, "schemas": { "CreateVaultAccountRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "color": { "type": "string", "description": "Color code used to visually identify the Vault Account, it should be a valid hex.", "example": "#00C7E6" }, "isHiddenInDashboard": { "type": "boolean", "description": "Indicates whether the vault account should be hidden from the dashboard.", "example": false }, "name": { "type": "string", "description": "The name of the Vault Account being created.", "example": "Vault Account Name" } }, "required": [ "color", "isHiddenInDashboard", "name" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "UpdateVaultAccountRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "color": { "type": "string", "description": "A HEX color value used to uniquely visually style this Vault Account in dashboards.", "example": "#00A3BF" }, "isFavoriteInDashboard": { "type": "boolean", "description": "Indicates whether the Vault Account has been marked as a \"favorite\" in the dashboard.", "example": true }, "isHiddenInDashboard": { "type": "boolean", "description": "Specifies whether this Vault Account is hidden from the main dashboard view.", "example": true }, "name": { "type": "string", "description": "The name of the Vault Account.", "example": "Vault Account Name" } } } }, "required": [ "item" ] } }, "required": [ "data" ] }, "AddAssetToAddressRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Address to associate with the asset. Used when the target address for adding the asset already exists in the vault account. Optional, but required if label is not provided.", "example": "0xa5bd60af2ed1499ce8292bb2e6c0179dcea34f33" }, "assetId": { "type": "string", "description": "Unique identifier of the asset to be added.", "example": "6913471c6b2794841dc8fb84" }, "label": { "type": "string", "description": "Optional, but required if address is not provided. Used when there is no existing address for the asset in the vault account.", "example": "Address name" } }, "required": [ "assetId" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "GenerateDepositAddressRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "label": { "type": "string", "description": "Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named \"Special addresses\".", "example": "yourLabelStringHere" }, "vaultAccountId": { "type": "string", "description": "Unique identifier of the vault account.", "example": "60c9d9921c38030006675ff6" } }, "required": [ "label", "vaultAccountId" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "ValidateAddressRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the specific address that will be checked if it's valid or not.", "example": "mho4jHBcrNCncKt38trJahXakuaBnS7LK5" } }, "required": [ "address" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "TronResourceManagementRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "amount": { "type": "string", "description": "The amount of TRX which will be freeze/unfreeze/delegate/undelegate. When type of request is withdraw-resource the amount is not required.", "example": "3" }, "lock": { "type": "string", "description": "Boolean if we want to lock the delegated amount. Whether to lock the resource delegation, true means locked the delegation, the delegating cannot be canceled within the period specified by lockPeriod, false means non-locked, the resource delegating can be canceled at any time", "example": "true" }, "lockPeriod": { "type": "string", "description": "Only when lock is true, this field is valid. If the delegate lock period is 1 day, the lock_period is: 28800. The minimum value of lockPeriod is the remaining lock period of this type of resource that was delegated last time, and the maximum value is 864000 (30 days). If lock is true and lock_period is not set or set to 0, lockPeriod will be set to the default value 86400 (3 days) automatically", "example": "28800" }, "note": { "type": "string", "description": "Transaction note with additional details.", "example": "Your note" }, "resource": { "type": "string", "description": "Resource staking for (e.g. Bandwidth, Energy).", "example": "bandwidth", "enum": [ "bandwidth", "energy" ] }, "toAddress": { "type": "string", "description": "Address receiving the delegated amount or from which we undelegate. It is used when type of the request is delegate/undelagate.", "example": "TJgba7p9nFz6vMgVBJUxTaRR8WbpaG6ifi" }, "type": { "type": "string", "description": "Type of the request (e.g. freeze, unfreeze, withdraw-resource)", "example": "freeze", "default": "freeze", "enum": [ "freeze", "unfreeze", "withdraw-resource", "delegate", "undelegate" ] } }, "required": [ "resource", "type" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateSingleTransferRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "amount": { "type": "string", "description": "Destination amount.", "example": "0.001" }, "assetId": { "type": "string", "description": "Unique internal identifier of the blockchain asset involved in the transaction.", "example": "6523e058a06ebf1322d7dd6e" }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast. Required for all blockchains except TRON and SOLANA.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "fromAddress": { "type": "string", "description": "Source address for the transaction and it must belong to vault account.", "example": "0x2d7127f27a2ca399cb3e3217140adc88d1d71fae" }, "gross": { "type": "boolean", "description": "Optional boolean. When true, the specified amount is gross (fee is deducted from it). Only supported for coin transactions without fee payer. Default is false (net amount).", "example": false }, "maxFee": { "type": "string", "description": "The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.", "example": "0.006" }, "note": { "type": "string", "description": "Represents an note to add a free text in, explaining or providing additional detail on the transaction request.", "example": "yourAdditionalInformationhere" }, "toAddress": { "type": "string", "description": "Destination address for the transaction.", "example": "0xbfe14b26d2680a232499f059d251f2486f32cdff" }, "vaultAccountId": { "type": "string", "description": "Unique identifier of the Vault Account.", "example": "6913471c6b2794841dc8fb81" } }, "required": [ "amount", "assetId", "fromAddress", "note", "toAddress", "vaultAccountId" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateMultipleTransferRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Unique internal identifier of the blockchain asset involved in the transaction.", "example": "6523e058a06ebf1322d7dd6f" }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "gross": { "type": "boolean", "description": "Optional boolean. When true, the specified amount is gross (fee is deducted from it). Default is false (net amount).", "example": false }, "maxFee": { "type": "string", "description": "The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.", "example": "0.003" }, "note": { "type": "string", "description": "Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.", "example": "yourAdditionalInformationhere" }, "prepareStrategy": { "type": "string", "description": "Refers to a model of a UTXO spending strategy, where customers can choose how to spend their transaction outputs from multiple addresses.", "example": "optimize-size", "enum": [ "minimize-dust", "optimize-size" ] }, "recipients": { "type": "array", "description": "Destinations for the transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Destination address.", "example": "bc1qut6n59lceee7s94g5qme08yzu8evd2yfjuuu3k" }, "amount": { "type": "string", "description": "Destination amount.", "example": "0.001" } }, "required": [ "address", "amount" ] } }, "vaultAccountId": { "type": "string", "description": "Unique identifier of the Vault Account.", "example": "6913471c6b2794841dc8fb81" } }, "required": [ "assetId", "feePriority", "note", "prepareStrategy", "recipients", "vaultAccountId" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "GasSponsorshipTransferRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "amount": { "type": "string", "description": "Destination amount.", "example": "0.001" }, "assetId": { "type": "string", "description": "Unique internal identifier of the blockchain asset involved in the transaction.", "example": "6523e058a06ebf1322d7dd6e" }, "feePayer": { "type": "string", "description": "Аddress to cover the fee. Applicable to Ethereum, Binance Smart Chain, Base, Optimism, Arbitrum, and Polygon.", "example": "0x92b23f96a3beeba16d5378709d8ca2ec0be5615f" }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast. Required for all blockchains except TRON and SOLANA.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "fromAddress": { "type": "string", "description": "Source address for the transaction and it must belong to vault account.", "example": "0x2d7127f27a2ca399cb3e3217140adc88d1d71fae" }, "maxFee": { "type": "string", "description": "The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.", "example": "0.006" }, "note": { "type": "string", "description": "Represents an note to add a free text in, explaining or providing additional detail on the transaction request.", "example": "yourAdditionalInformationhere" }, "toAddress": { "type": "string", "description": "Destination address for the transaction.", "example": "0xbfe14b26d2680a232499f059d251f2486f32cdff" }, "vaultAccountId": { "type": "string", "description": "Unique identifier of the Vault Account.", "example": "6913471c6b2794841dc8fb81" } }, "required": [ "amount", "assetId", "feePayer", "fromAddress", "note", "toAddress", "vaultAccountId" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateBatchTransactionRequestRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "feePayer": { "type": "object", "description": "Fee payer data used to resolve blockchain/network", "properties": { "address": { "type": "string", "description": "Address responsible for paying transaction fees.", "example": "0xa5bd60af2ed1499ce8292bb2e6c0179dcea34f33" }, "assetId": { "type": "string", "description": "Asset used to pay gas fees.", "example": "6913471c6b2794841dc8fb7e" } }, "required": [ "address", "assetId" ] }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "fromAddress": { "type": "string", "description": "Address initiating the batch transaction.", "example": "0x9b08125f3fb134f0ebb462ccff0f463bcfb4f623" }, "note": { "type": "string", "description": "Represents an note to add a free text in, explaining or providing additional detail on the transaction request.", "example": "yourAdditionalInformationhere" }, "recipients": { "type": "array", "description": "Destination of the transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Recipient address for the transfer.", "example": "0xd2070342a1a5ce24930ec6582b3db846458525a0" }, "amount": { "type": "string", "description": "Amount to transfer.", "example": "0.001" }, "assetId": { "type": "string", "description": "Asset identifier being transferred.", "example": "6913471c6b2794841dc8fb7e" } }, "required": [ "address", "amount", "assetId" ] } }, "vaultAccountId": { "type": "string", "description": "Unique identifier of the Vault Account.", "example": "68dfae9739a4b80007c4f706" } }, "required": [ "feePayer", "feePriority", "fromAddress", "note", "recipients" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "EstimateApproximateTransactionFeeByAssetIDRB": { "type": "object", "properties": { "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount to transfer. Required for Single and Gas sponsorship transfers.", "example": "0.001" }, "assetId": { "type": "string", "description": "The identifier of the asset to transfer. (Required for Single, Gas sponsorship and Multiple transfers).", "example": "6995822ce883e61317b3d6b6" }, "feePayer": { "type": "string", "description": "Fee payer (sponsor) address . Required for Batch and Gas sponsorship transfers.", "example": "0x0c3f01e4b2aae7c258f044c4cb64354f487abe8b" }, "feePayerAssetId": { "type": "string", "description": "Asset ID of the fee payer . Required for Batch transfer.", "example": "6995822ce883e61317b3d6b6" }, "feePriority": { "type": "string", "description": "Fee priority - slow, standard, fast. Not applicable for Tron and Solana.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "fromAddress": { "type": "string", "description": "Sender address. Required for Single, Batch and Gas sponsorship transfers.", "example": "0x463ebfb8eb88b41fd57952a407c14409fc0fb9a4" }, "prepareStrategy": { "type": "string", "description": "Strategy for preparing transaction - minimize_dust or optimize_size. (used for UTXO transactions).", "example": "optimize_size", "enum": [ "minimize_dust", "optimize_size" ] }, "recipients": { "type": "array", "description": "Destination addresses with amounts. Required for Multiple and Batch transfers.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Address of the destination. Required for Multiple and Batch transfers.", "example": "0x9e1046549484c5e17b00fb40beda0abbdf9cfca9" }, "amount": { "type": "string", "description": "Amount to transfer. Required for Multiple and Batch transfers.", "example": "0.001" }, "assetId": { "type": "string", "description": "Asset ID for this destination. Required for Batch transfer, provide assetId inside each recipient object instead.", "example": "6995822ce883e61317b3d6b6" } } } }, "toAddress": { "type": "string", "description": "The recipient's address. Required for EVM transactions - Single and Gas sponsorship transfers.", "example": "0xd2070342a1a5ce24930ec6582b3db846458525a0" }, "transactionType": { "type": "string", "description": "Type of transaction: single, multiple, batch. Gas sponsorship transfer use transactionType: single.", "example": "single" }, "vaultAccountId": { "type": "string", "description": "Sender's vault account ID.", "example": "69c28b729d1ca8000714911a" } }, "required": [ "transactionType", "vaultAccountId" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateVaultAccountRI": { "type": "object", "properties": { "addressesCount": { "type": "string", "description": "The total number of addresses associated with this Vault Account.", "example": "12" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The ID of the asset.", "example": "691c92a08e6be3c9d32d2c8a" }, "assetName": { "type": "string", "description": "Asset name - bitcoin, binance-smart-chain, tron, solana.", "example": "Ethereum" }, "assetUnit": { "type": "string", "description": "The symbol of the asset.", "example": "ETH" }, "blockchain": { "type": "string", "description": "The blockchain of the asset.", "example": "ethereum" }, "exchangeRateUnit": { "type": "string", "description": "The pricing unit used when calculating exchange rates.", "example": "USD" }, "latestExchangeRateToUSD": { "type": "string", "description": "The most recent exchange rate of the currency relative to USD.", "example": "2822.59" }, "totalAmount": { "type": "string", "description": "The total amount of this asset held in the Vault Account.", "example": "0.123" } }, "required": [ "assetId", "assetName", "assetUnit", "blockchain", "exchangeRateUnit", "latestExchangeRateToUSD", "totalAmount" ] } }, "createdAt": { "type": "integer", "description": "Unix timestamp indicating when the Vault Account was created.", "example": 1760621154 }, "index": { "type": "string", "description": "Internal sequential index of the Vault Account within the vault.", "example": "1" }, "isHiddenInDashboard": { "type": "boolean", "description": "Indicates whether the vault account should be hidden from the dashboard.", "example": false }, "vaultAccountColour": { "type": "string", "description": "The assigned color of the Vault Account.", "example": "#5243AA" }, "vaultAccountId": { "type": "string", "description": "Unique ID of the newly created Vault Account.", "example": "692d72c58cb7dd000704981a" }, "vaultAccountName": { "type": "string", "description": "The name of the Vault Account.", "example": "Vault Account Name" }, "vaultId": { "type": "string", "description": "The ID of the vault for which a Vault Account is created.", "example": "66d866bd469e1d00079d91d5" } }, "required": [ "addressesCount", "balances", "createdAt", "index", "isHiddenInDashboard", "vaultAccountColour", "vaultAccountId", "vaultAccountName", "vaultId" ] }, "CreateVaultAccountR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateVaultAccountRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "UriNotFound": { "type": "object", "description": "uri_not_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "uri_not_found" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified URI has not been found. Check the URI and try again." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "UnexpectedServerError": { "type": "object", "description": "unexpected_server_error", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "unexpected_server_error" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "MissingApiKey": { "type": "object", "description": "missing_api_key", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "missing_api_key" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "UnsupportedMediaType": { "type": "object", "description": "unsupported_media_type", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "unsupported_media_type" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "RequestLimitReached": { "type": "object", "description": "request_limit_reached", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "request_limit_reached" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InvalidApiKey": { "type": "object", "description": "invalid_api_key", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_api_key" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The provided API key is invalid. Please, generate a new one from your Dashboard." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "CreateVaultAccountE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "InvalidData": { "type": "object", "description": "invalid_data", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_data" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The data provided seems to be invalid." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "LimitGreaterThanAllowed": { "type": "object", "description": "limit_greater_than_allowed", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "limit_greater_than_allowed" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "CreateVaultAccountE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "InvalidPagination": { "type": "object", "description": "invalid_pagination", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_pagination" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "EndpointNotAllowedForPlan": { "type": "object", "description": "endpoint_not_allowed_for_plan", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "endpoint_not_allowed_for_plan" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "EndpointNotAllowedForApiKey": { "type": "object", "description": "endpoint_not_allowed_for_api_key", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "endpoint_not_allowed_for_api_key" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This endpoint is not available for your API key." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "CreateVaultAccountE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/VaultAccountsLimitReached" }, { "$ref": "#/components/schemas/VaultAsAServiceVaultRecoveryNotInitialized" }, { "$ref": "#/components/schemas/VaultAccountsNotAllowedForVaultType" } ] }, "FeatureMainnetsNotAllowedForPlan": { "type": "object", "description": "feature_mainnets_not_allowed_for_plan", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "feature_mainnets_not_allowed_for_plan" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InvalidRequestBodyStructure": { "type": "object", "description": "invalid_request_body_structure", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_request_body_structure" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }" }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "ResourceNotFound": { "type": "object", "description": "resource_not_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "resource_not_found" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The specified resource has not been found." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "VaultAccountsCreationFailed": { "type": "object", "description": "vault_accounts_creation_failed", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "vault_accounts_creation_failed" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Failed to create vault account. A vault account with index {index} already exists." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "CreateVaultAccountE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/VaultAccountsCreationFailed" } ] }, "VaultAccountsLimitReached": { "type": "object", "description": "vault_accounts_limit_reached", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "vault_accounts_limit_reached" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "You have reached the maximum Vault Accounts count which is currently {vaultAccountsLimit}. Please, upgrade your plan in order to have a higher Vault Account count." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "VaultAsAServiceVaultRecoveryNotInitialized": { "type": "object", "description": "vault_as_a_service_vault_recovery_not_initialized", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "vault_as_a_service_vault_recovery_not_initialized" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Your Vault recovery has not been initialized." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "VaultAccountsNotAllowedForVaultType": { "type": "object", "description": "vault_accounts_not_allowed_for_vault_type", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "vault_accounts_not_allowed_for_vault_type" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Vault accounts can only be created for vaults of type DEFAULT." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "ListVaultAccountsRI": { "type": "object", "properties": { "addressesCount": { "type": "string", "description": "The total number of addresses associated with this Vault Account.", "example": "12" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The specific id of the assets.", "example": "6913471c6b2794841dc8fb7e" }, "assetName": { "type": "string", "description": "Full name of the asset (e.g., Ethereum, Base, Optimism, Tron, Bitcoin, Dogecoin,).", "example": "Ethereum" }, "assetUnit": { "type": "string", "description": "The commonly used symbol for the asset (e.g., ETH, BTC, TRX, BNB).", "example": "ETH" }, "blockchain": { "type": "string", "description": "The blockchain network where this asset resides (e.g., ethereum, bitcoin, optimism, tron, binance-smart-chain).", "example": "ethereum" }, "exchangeRateUnit": { "type": "string", "description": "The pricing unit used when calculating exchange rates.", "example": "USD" }, "latestExchangeRateToUSD": { "type": "string", "description": "The latest exchange rate of the asset to USD.", "example": "2822.59" }, "totalAmount": { "type": "string", "description": "The total amount of this asset held in the Vault Account.", "example": "0.123" } }, "required": [ "assetId", "assetName", "assetUnit", "blockchain", "exchangeRateUnit", "latestExchangeRateToUSD", "totalAmount" ] } }, "createdAt": { "type": "integer", "description": "The UNIX timestamp indicating when the Vault Account was first created.", "example": 1760088530 }, "index": { "type": "integer", "description": "The sequential index of this Vault Account within its parent Vault.", "example": 1 }, "isFavoriteInDashboard": { "type": "boolean", "description": "Indicates whether the Vault Account has been marked as a \"favorite\" in the dashboard.", "example": true }, "isHiddenInDashboard": { "type": "boolean", "description": "Specifies whether this Vault Account is hidden from the main dashboard view.", "example": true }, "vaultAccountColour": { "type": "string", "description": "A HEX color value used to uniquely visually style this Vault Account in dashboards.", "example": "#00A3BF" }, "vaultAccountId": { "type": "string", "description": "The unique id of the Vault Account.", "example": "68dfaeae39a4b80007c4f707" }, "vaultAccountName": { "type": "string", "description": "The name of the Vault Account.", "example": "Vault Account Name" }, "vaultId": { "type": "string", "description": "The id of the Vault to which this Vault Account belongs.", "example": "68dfaeae39a4b80007c4f707" } }, "required": [ "addressesCount", "balances", "createdAt", "index", "isFavoriteInDashboard", "isHiddenInDashboard", "vaultAccountColour", "vaultAccountId", "vaultAccountName", "vaultId" ] }, "ListVaultAccountsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListVaultAccountsRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListVaultAccountsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListVaultAccountsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListVaultAccountsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetVaultAccountByIDRI": { "type": "object", "properties": { "addressesCount": { "type": "string", "description": "The total number of addresses associated with this Vault Account.", "example": "12" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The specific id of the assets.", "example": "6913471c6b2794841dc8fb7e" }, "assetName": { "type": "string", "description": "Full name of the asset (e.g., Ethereum, Base, Optimism, Tron, Bitcoin, Dogecoin,).", "example": "Ethereum" }, "assetUnit": { "type": "string", "description": "The commonly used symbol for the asset (e.g., ETH, BTC, TRX, BNB).", "example": "ETH" }, "blockchain": { "type": "string", "description": "The blockchain network where this asset resides (e.g., ethereum, bitcoin, optimism, tron, binance-smart-chain).", "example": "ethereum" }, "exchangeRateUnit": { "type": "string", "description": "The pricing unit used when calculating exchange rates.", "example": "USD" }, "latestExchangeRateToUSD": { "type": "string", "description": "The latest exchange rate of the asset to USD.", "example": "2822.59" }, "totalAmount": { "type": "string", "description": "The total amount of this asset held in the Vault Account.", "example": "0.123" } }, "required": [ "assetId", "assetName", "assetUnit", "blockchain", "exchangeRateUnit", "latestExchangeRateToUSD", "totalAmount" ] } }, "createdAt": { "type": "integer", "description": "The UNIX timestamp indicating when the Vault Account was first created.", "example": 1760088530 }, "index": { "type": "string", "description": "The sequential index of this Vault Account within its parent Vault.", "example": "1" }, "isFavorityInDashboard": { "type": "boolean", "description": "Indicates whether the Vault Account has been marked as a \"favorite\" in the dashboard.", "example": true }, "isHiddenInDashboard": { "type": "boolean", "description": "Specifies whether this Vault Account is hidden from the main dashboard view.", "example": false }, "vaultAccountColour": { "type": "string", "description": "A HEX color value used to uniquely visually style this Vault Account in dashboards.", "example": "#00A3BF" }, "vaultAccountId": { "type": "string", "description": "The unique id of the Vault Account.", "example": "69382b15411179000710d73e" }, "vaultAccountName": { "type": "string", "description": "The name of the Vault Account.", "example": "Vault Account Name" }, "vaultId": { "type": "string", "description": "The id of the Vault to which this Vault Account belongs.", "example": "68dfae9739a4b80007c4f706" } }, "required": [ "addressesCount", "balances", "createdAt", "index", "isFavorityInDashboard", "isHiddenInDashboard", "vaultAccountColour", "vaultAccountId", "vaultAccountName", "vaultId" ] }, "GetVaultAccountByIDR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetVaultAccountByIDRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetVaultAccountByIDE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetVaultAccountByIDE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetVaultAccountByIDE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/VaultAccountsUserNotAuthorized" } ] }, "VaultAccountsUserNotAuthorized": { "type": "object", "description": "vault_accounts_user_not_authorized", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "vault_accounts_user_not_authorized" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The user is not authorized to access the vault accounts." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "UpdateVaultAccountRI": { "type": "object", "properties": { "addressesCount": { "type": "string", "description": "The total number of addresses associated with this Vault Account.", "example": "12" }, "createdAt": { "type": "integer", "description": "The UNIX timestamp indicating when the Vault Account was first created.", "example": 1760088530 }, "index": { "type": "string", "description": "The sequential index of this Vault Account within its parent Vault.", "example": "1" }, "isHiddenInDashboard": { "type": "boolean", "description": "Specifies whether this Vault Account is hidden from the main dashboard view.", "example": true }, "vaultAccountColour": { "type": "string", "description": "A HEX color value used to uniquely visually style this Vault Account in dashboards.", "example": "#00A3BF" }, "vaultAccountId": { "type": "string", "description": "The unique id of the Vault Account.", "example": "662b8dbe5c96b000064b23e8" }, "vaultAccountName": { "type": "string", "description": "The name of the Vault Account.", "example": "Vault Account Name" }, "vaultId": { "type": "string", "description": "The id of the Vault to which this Vault Account belongs.", "example": "68dfaeae39a4b80007c4f707" } }, "required": [ "addressesCount", "createdAt", "index", "isHiddenInDashboard", "vaultAccountColour", "vaultAccountId", "vaultAccountName", "vaultId" ] }, "UpdateVaultAccountR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/UpdateVaultAccountRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "UpdateVaultAccountE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "UpdateVaultAccountE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "UpdateVaultAccountE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/VaultAccountsUserNotAuthorized" } ] }, "ListAssetsByVaultAccountIDRI": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Unique identifier of the asset.", "example": "6913471c6b2794841dc8fb6f" }, "assetUnit": { "type": "string", "description": "Asset symbol (e.g., BTC, ETH, LTC, USDC).", "example": "BTC" }, "availableAmount": { "type": "string", "description": "Amount of the asset available in the vault account.", "example": "0.001" }, "blockchain": { "type": "string", "description": "Blockchain network on which the asset exists (e.g., bitcoin, ethereum).", "example": "bitcoin" }, "exchangeRateToUsd": { "type": "string", "description": "Current exchange rate of the asset to USD.", "example": "69156.14" } }, "required": [ "assetId", "assetUnit", "availableAmount", "blockchain", "exchangeRateToUsd" ] }, "ListAssetsByVaultAccountIDR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListAssetsByVaultAccountIDRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListAssetsByVaultAccountIDE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListAssetsByVaultAccountIDE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListAssetsByVaultAccountIDE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListSupportedAssetsRI": { "type": "object", "properties": { "active": { "type": "string", "description": "Whether asset is currently supported.", "example": "true" }, "assetId": { "type": "string", "description": "The specific asset ID.", "example": "6523e058a06ebf1322d7dd6f" }, "assetName": { "type": "string", "description": "The name of the asset (e.g., Litecoin, Dogecoin,, Polygon, Tron, Avalanch, ChainLink, JUST, Tether).", "example": "Ethereum" }, "assetType": { "type": "string", "description": "Type of asset - COIN, TOKEN.", "example": "TOKEN" }, "assetUnit": { "type": "string", "description": "Asset symbol (e.g., BTC, BNB, USDC, TRX, LINK).", "example": "ETH" }, "blockchain": { "type": "string", "description": "Represents the blockchain of the asset, e.g. bitcoin, litecoin, binance-smart-chain, tron, polygon, base.", "example": "ethereum" }, "contractAddress": { "type": "string", "description": "Smart contract address (if applicable, for token type assets).", "example": "0x1c7d4b196cb0c7b01d743fbc6116a902379c7238" }, "contractType": { "type": "string", "description": "Token standard type (BEP-20, ERC-20, etc.) - for tokens only.", "example": "ERC-20" }, "decimals": { "type": "string", "description": "Number of decimal places supported by the asset.", "example": "6" }, "network": { "type": "string", "description": "Represents the network of the asset e.g. mainnet, testnet, sepolia, nile.", "example": "mainnet" }, "price": { "type": "object", "description": "Current price information for the asset.", "properties": { "amount": { "type": "string", "description": "Current price value.", "example": "2147.2241" }, "calculationTimestamp": { "type": "integer", "description": "Unix timestamp indicating when the price was calculated", "example": 1770727800 }, "unit": { "type": "string", "description": "Price currency.", "example": "USD" } }, "required": [ "amount", "calculationTimestamp", "unit" ] } }, "required": [ "active", "assetId", "assetName", "assetType", "assetUnit", "blockchain", "contractAddress", "contractType", "decimals", "network", "price" ] }, "ListSupportedAssetsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListSupportedAssetsRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListSupportedAssetsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListSupportedAssetsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListSupportedAssetsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "AddAssetToAddressRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Blockchain address associated with the asset.", "example": "0xa5bd60af2ed1499ce8292bb2e6c0179dcea34f33" }, "assetUnit": { "type": "string", "description": "Ticker symbol of the added asset (e.g.,ETH, BTC, TRX, USDT).", "example": "ETH" }, "balance": { "type": "string", "description": "Current balance of the asset in the address.", "example": "0" }, "contractAddress": { "type": "string", "description": "Smart contract address of the token.", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" }, "decimals": { "type": "string", "description": "Number of decimal places supported by the asset.", "example": "6" } }, "required": [ "address", "assetUnit", "balance", "contractAddress", "decimals" ] }, "AddAssetToAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/AddAssetToAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "AddAssetToAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "AddAssetToAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "AddAssetToAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GenerateDepositAddressRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Specifies the specific address's unique string value.", "example": "2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific UNIX time when the deposit address was created.", "example": 1624028267 }, "label": { "type": "string", "description": "Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named \"Special addresses\".", "example": "yourLabelStringHere" } }, "required": [ "address", "createdTimestamp", "label" ] }, "GenerateDepositAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GenerateDepositAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GenerateDepositAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GenerateDepositAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GenerateDepositAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/VaultAsAServiceDepositAddressesLimitReached" }, { "$ref": "#/components/schemas/VaultAsAServiceProvidedNetworkIsNotSuitableForThisVaultType" } ] }, "VaultAsAServiceDepositAddressesLimitReached": { "type": "object", "description": "vault_as_a_service_deposit_addresses_limit_reached", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "vault_as_a_service_deposit_addresses_limit_reached" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "You have reached the maximum Deposit Addresses count which is currently {depositAddressesCount}. Please, upgrade your plan in order to have a higher Deposit Address count." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "VaultAsAServiceProvidedNetworkIsNotSuitableForThisVaultType": { "type": "object", "description": "vault_as_a_service_provided_network_is_not_suitable_for_this_vault_type", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "vault_as_a_service_provided_network_is_not_suitable_for_this_vault_type" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This vault is not for the provided network." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "AddressDerivationConflict": { "type": "object", "description": "address_derivation_conflict", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "address_derivation_conflict" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Address derivation failed due to concurrent requests. Please try again." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "GenerateDepositAddressE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/AddressDerivationConflict" } ] }, "ValidateAddressRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Represents the specific address that will be checked if it's valid or not.", "example": "15XyNC88pujwuuur8DCsXBCfEhJJMzHayU" }, "isValid": { "type": "boolean", "description": "Defines whether the address is valid or not. Set as boolean.", "example": true } }, "required": [ "address", "isValid" ] }, "ValidateAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ValidateAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ValidateAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ValidateAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ValidateAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListVaultsRI": { "type": "object", "properties": { "backuped": { "type": "boolean", "description": "Represents whether the Vault is backuped.", "example": true }, "changeAddressesCount": { "type": "integer", "format": "int64", "description": "The number of change addresses associated with the Vault.", "example": 3 }, "color": { "type": "string", "description": "Represents the color of the Vault.", "example": "#2684FF" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific UNIX time when the Vault was created.", "example": 1704881727 }, "depositAddressesCount": { "type": "integer", "format": "int64", "description": "The number of deposit addresses associated with the Vault.", "example": 1 }, "id": { "type": "string", "description": "Defines the unique ID of the Vault.", "example": "64d0d39df6762400071440c3" }, "name": { "type": "string", "description": "Defines the name of the Vault given to it by the user.", "example": "Vault name" }, "type": { "type": "string", "description": "Represents the type of the Vault - main/test.", "example": "main", "enum": [ "main", "test" ] } }, "required": [ "backuped", "changeAddressesCount", "color", "createdTimestamp", "depositAddressesCount", "id", "name", "type" ] }, "ListVaultsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListVaultsRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListVaultsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListVaultsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListVaultsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListVaultsByAssetIDRI": { "type": "object", "properties": { "exchangeRateUnit": { "type": "string", "description": "The current exchange rate.", "example": "1.2" }, "vaults": { "type": "array", "items": { "type": "object", "properties": { "allocatedAmount": { "type": "string", "description": "Allocated amount in the Vault.", "example": "2" }, "availableAmount": { "type": "string", "description": "Available amount in the Vault.", "example": "3.1" }, "totalAmount": { "type": "string", "description": "Total amount in the Vault.", "example": "5.00001" }, "vaultColor": { "type": "string", "description": "The color of the Vault.", "example": "#FF991F" }, "vaultId": { "type": "string", "description": "Defines the unique ID of the Vault.", "example": "654a4ad6d6aeb3000769074d" }, "vaultName": { "type": "string", "description": "The name of the Vault.", "example": "Main Vault" }, "vaultType": { "type": "string", "description": "Represents the type of the Vault.", "example": "default", "enum": [ "default" ] } }, "required": [ "allocatedAmount", "availableAmount", "totalAmount", "vaultColor", "vaultId", "vaultName", "vaultType" ] } } }, "required": [ "exchangeRateUnit", "vaults" ] }, "ListVaultsByAssetIDR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ListVaultsByAssetIDRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListVaultsByAssetIDE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListVaultsByAssetIDE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListVaultsByAssetIDE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListAddressesByVaultAccountIDRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Blockchain address.", "example": "0xa5bd60af2ed1499ce8292bb2e6c0179dcea34f33" }, "addressId": { "type": "string", "description": "Unique identifier of the address (address ID to start after).", "example": "68e4c62889a82e0ff4d8f737" }, "addressIndex": { "type": "string", "description": "Derivation index of the address within the vault account.", "example": "1" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "Balance amount for the asset on this address.", "example": "0.123" }, "assetId": { "type": "string", "description": "Unique identifier of the asset.", "example": "68e4c62889a82e0ff4d8f737" }, "assetUnit": { "type": "string", "description": "Asset symbol (e.g., BTC, ETH, USDT, TRX).", "example": "ETH" } }, "required": [ "amount", "assetId", "assetUnit" ] } }, "blockchain": { "type": "string", "description": "Blockchain for the address (e.g., bitcoin, ethereum, tron).", "example": "ethereum" }, "createdTimestamp": { "type": "integer", "description": "Unix timestamp (seconds) indicating when the address was created.", "example": 1759823400 }, "label": { "type": "string", "description": "Human-readable label assigned to the address.", "example": "Name address" } }, "required": [ "address", "addressId", "addressIndex", "balances", "blockchain", "createdTimestamp", "label" ] }, "ListAddressesByVaultAccountIDR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListAddressesByVaultAccountIDRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListAddressesByVaultAccountIDE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListAddressesByVaultAccountIDE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListAddressesByVaultAccountIDE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListAssetsByVaultRI": { "type": "object", "properties": { "assets": { "type": "array", "items": { "type": "object", "properties": { "assetData": { "type": "object", "properties": { "allocatedAmount": { "type": "string", "description": "Represents the allocated amount of the asset in the particular vault.", "example": "0" }, "availableAmount": { "type": "string", "description": "Represents the available amount of the asset in the particular vault.", "example": "986.1" }, "contractAddress": { "type": "string", "description": "Represents the token identifier.", "example": "0x1c7d4b196cb0c7b01d743fbc6116a902379c7238" }, "standard": { "type": "string", "description": "Represents the token standard, e.g. ERC-20, TRC-20.", "example": "TRC-20" }, "totalAmount": { "type": "string", "description": "Represents the amount of the asset in the particular vault.", "example": "986.10" } }, "required": [ "allocatedAmount", "availableAmount", "contractAddress", "standard", "totalAmount" ] }, "assetId": { "type": "string", "description": "Represents the specific asset ID", "example": "6523e058a06ebf1322d7dd6f" }, "assetUnit": { "type": "string", "description": "The specific asset symbol, e.g BTC, ETH, BNB, TRX, USDT, USDC.", "example": "USDT" }, "blockchain": { "type": "string", "description": "Represents the blockchain of the asset in the particular vault, e.g. Bitcoin, Ethereum, Binance Smart Chain, Tron.", "example": "bitcoin" }, "exchangeRateUnit": { "type": "string", "description": "Represents the exchange rate of the asset in USD.", "example": "77235.11" }, "network": { "type": "string", "description": "Represents the network of the asset in the particular vault, e.g. testnet, sepolia, nile.", "example": "mainnet" }, "type": { "type": "string", "description": "Represents the type of the asset - COIN/TOKEN", "example": "TOKEN" } }, "required": [ "assetData", "assetId", "assetUnit", "blockchain", "exchangeRateUnit", "network", "type" ] } } }, "required": [ "assets" ] }, "ListAssetsByVaultR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ListAssetsByVaultRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListAssetsByVaultE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListAssetsByVaultE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListAssetsByVaultE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByVaultRI": { "type": "object", "properties": { "blockchain": { "type": "string", "description": "The blockchain protoocl, e.g Bitcoin, Ethereum, Binance-smart-chain, Optimism, Solana, Tron.", "example": "ethereum" }, "createdTimestamp": { "type": "integer", "description": "When this transaction was created.", "example": 1705399159 }, "direction": { "type": "string", "description": "The direction of the transaction in this Vault, incoming or outgoing transaction.", "example": "incoming" }, "hasTokenTransfer": { "type": "boolean", "description": "If this transaction has any tokens transfers", "example": false }, "id": { "type": "string", "description": "The transaction ID in Vaultody, this is needed for pagination/load more functionality.", "example": "654ba3af9e8dd80901f17347" }, "isInternal": { "type": "boolean", "description": "If this transaction has any Internal Transactions.", "example": false }, "minedInBlockHeight": { "type": "string", "description": "The block height this transaction was mined in.", "example": "1234324" }, "network": { "type": "string", "description": "The blockchain network.", "example": "nile" }, "recipients": { "type": "array", "description": "Recipients are all addresses receive assets in this transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The public address itself.", "example": "0xd2070342a1a5ce24930ec6582b3db846458525a0" }, "addressType": { "type": "string", "description": "The address type, e.g deposit.", "example": "deposit" }, "amount": { "type": "string", "description": "The amount received.", "example": "0.0003" }, "amountUnit": { "type": "string", "description": "The unit symbol e.g. BTC, TRX, BNB.", "example": "ETH" }, "isVaultAddress": { "type": "string", "description": "If this address belongs to this Vault or not.", "example": "true" }, "label": { "type": "string", "description": "The label of the address.", "example": "Address name" } }, "required": [ "address", "amount", "amountUnit", "isVaultAddress" ] } }, "senders": { "type": "array", "description": "Senders are all addresses send assets in this transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The public sender's address.", "example": "0xa94b8eca8703ad2804cb204976ac023b612c407e" }, "addressType": { "type": "string", "description": "The address type , e.g. deposit.", "example": "deposit" }, "amount": { "type": "string", "description": "The amount sent.", "example": "0.0003" }, "amountUnit": { "type": "string", "description": "The symbol, e.g BTC, TRX, BNB, ETH.", "example": "ETH" }, "isVaultAddress": { "type": "string", "description": "If this address belongs to this Vault.", "example": "true" }, "label": { "type": "string", "description": "The address label.", "example": "Address name" } }, "required": [ "address", "amount", "amountUnit", "isVaultAddress" ] } }, "status": { "type": "string", "description": "The status of this transaction.", "example": "confirmed" }, "transactionFee": { "type": "object", "description": "The transaction fee details.", "properties": { "amount": { "type": "string", "description": "The transaction fee amount.", "example": "0.0024" }, "amountUnit": { "type": "string", "description": "The transaction fee symbol.", "example": "ETH" } }, "required": [ "amount", "amountUnit" ] }, "transactionId": { "type": "string", "description": "The blockchain transaction ID.", "example": "281a63d28ddf6d0d5d78090b7cdf3a8c0be95bbb296544943ef45d9dec44405d" } }, "required": [ "blockchain", "createdTimestamp", "direction", "hasTokenTransfer", "id", "isInternal", "minedInBlockHeight", "network", "recipients", "senders", "status", "transactionFee", "transactionId" ] }, "ListTransactionsByVaultR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByVaultRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByVaultE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByVaultE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByVaultE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "TronResourceOverviewRI": { "type": "object", "properties": { "address": { "type": "string", "description": "The address associated with the staking activity.", "example": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4" }, "balance": { "type": "object", "properties": { "available": { "type": "string", "description": "Available amount is total amount without available frozen amount and delegated amount.", "example": "70" }, "availableFrozen": { "type": "string", "description": "Amount including total frozen without delegated amount.", "example": "30.123" }, "delegated": { "type": "string", "description": "Amount that is used for freezing resources for another address.", "example": "0" }, "total": { "type": "string", "description": "Total TRX balance, including available, availableFrozen, delegated and withdrawableAmount amounts.", "example": "100.123" }, "unit": { "type": "string", "description": "Defines the unit of the amount.", "example": "TRX" }, "withdrawableAmount": { "type": "string", "description": "The amount of TRX that has been successfully unstaked and has passed the mandatory waiting period (e.g., 14 days in Stake 2.0). This balance is now available for withdrawal back to the user’s account.", "example": "1" } }, "required": [ "available", "availableFrozen", "delegated", "total", "unit", "withdrawableAmount" ] }, "frozenResources": { "type": "object", "properties": { "bandwidth": { "type": "string", "description": "Type of frozen resource - bandwidth.", "example": "10" }, "energy": { "type": "string", "description": "Type of frozen resource - energy.", "example": "20.123" }, "tronPower": { "type": "string", "description": "Type of frozen resource - tron voting power.", "example": "0" } }, "required": [ "bandwidth", "energy", "tronPower" ] }, "network": { "type": "string", "description": "The network (e.g., mainnet, nile).", "example": "mainnet" }, "resources": { "type": "object", "properties": { "bandwidth": { "type": "object", "description": "Info about account's bandwidth", "properties": { "acquiredDelegated": { "type": "string", "description": "TRX amount equivalent to the acquired delegated bandwidth by others for this account.", "example": "0" }, "available": { "type": "integer", "format": "int64", "description": "Available bandwidth including free bandwidth, from frozen TRX and from others' delegation.", "example": 1035 }, "delegated": { "type": "string", "description": "TRX amount equivalent to the delegated bandwidth for others from this account.", "example": "0" }, "freeLimit": { "type": "integer", "format": "int64", "description": "Depending on Tron - 600 for all accounts.", "example": 600 }, "freeUsed": { "type": "integer", "format": "int64", "description": "Free bandwidth used.", "example": 0 }, "limit": { "type": "integer", "format": "int64", "description": "Total bandwidth obtained by staking.", "example": 1035 }, "used": { "type": "integer", "format": "int64", "description": "Used amount of bandwidth obtained by staking.", "example": 0 } }, "required": [ "acquiredDelegated", "available", "delegated", "freeLimit", "freeUsed", "limit", "used" ] }, "energy": { "type": "object", "description": "Info about account's energy.", "properties": { "acquiredDelegated": { "type": "string", "description": "TRX amount equivalent to the acquired delegated energy by others for this account.", "example": "0" }, "available": { "type": "integer", "format": "int64", "description": "Available energy, including from frozen TRX and from others' delegation.", "example": 775 }, "delegated": { "type": "string", "description": "TRX amount equivalent to the delegated energy for others from this account.", "example": "0" }, "limit": { "type": "integer", "format": "int64", "description": "Total energy obtained by staking.", "example": 775 }, "used": { "type": "integer", "format": "int64", "description": "Energy used.", "example": 0 } }, "required": [ "acquiredDelegated", "available", "delegated", "limit", "used" ] } }, "required": [ "bandwidth", "energy" ] } }, "required": [ "address", "balance", "frozenResources", "network", "resources" ] }, "TronResourceOverviewR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/TronResourceOverviewRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "TronResourceOverviewE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "TronResourceOverviewE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "TronResourceOverviewE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "TronResourceManagementRI": { "type": "object", "properties": { "blockchain": { "type": "string", "description": "Specifies the blockchain network involved in the transaction. (eg. tron).", "example": "tron", "enum": [ "tron" ] }, "destination": { "type": "array", "description": "Destination of the transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Address of the destination that will receive the resources.", "example": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4" }, "amount": { "type": "string", "description": "The amount of TRX being staked/unfrozen.", "example": "3" }, "amountUnit": { "type": "string", "description": "The unit of currency used in the transaction.", "example": "TRX" } }, "required": [ "address", "amount", "amountUnit" ] } }, "id": { "type": "string", "description": "A unique identifier for the transaction.", "example": "67a336950ca2f4fd25fb0deb" }, "network": { "type": "string", "description": "Specifies the network used (eg. mainnet, nile).", "example": "mainnet", "enum": [ "mainnet", "nile" ] }, "resource": { "type": "string", "description": "Specifies the type of the resource being managed(eg. bandwidth, energy)", "example": "energy" }, "source": { "type": "object", "description": "Details about the sender.", "properties": { "address": { "type": "string", "description": "The address of the sender.", "example": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4" } }, "required": [ "address" ] }, "status": { "type": "string", "description": "Defines the status of the transaction request, (e.g. created).", "example": "created", "enum": [ "created", "await-approval-l2" ] }, "type": { "type": "string", "description": "The type of staking operation being performed (eg. freeze, unfreeze, withdraw-resource)", "example": "freeze", "enum": [ "automation-token", "freeze", "unfreeze", "withdraw-resource", "delegate", "undelegate" ] }, "vaultId": { "type": "string", "description": "Identifies the vault id linked to the transaction.", "example": "66d9b73a9f455b085ed9de39" } }, "required": [ "blockchain", "destination", "id", "network", "resource", "source", "status", "type", "vaultId" ] }, "TronResourceManagementR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/TronResourceManagementRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "TronResourceManagementE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "TronResourceManagementE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "TronResourceManagementE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/InsufficientFrozenAmount" }, { "$ref": "#/components/schemas/MaximumUnfreezeOperationsReached" }, { "$ref": "#/components/schemas/NoWithdrawableBalance" }, { "$ref": "#/components/schemas/DelegatedResourcesLocked" } ] }, "WalletAsAServiceWalletBalanceNotEnough": { "type": "object", "description": "wallet_as_a_service_wallet_balance_not_enough", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "wallet_as_a_service_wallet_balance_not_enough" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Your wallet balance is insufficient to complete this action. Please check for any pending transaction requests or add more funds." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "TronResourceManagementE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/CallbackUrlNotVerified" } ] }, "WalletAsAServiceAddressBalanceNotEnough": { "type": "object", "description": "wallet_as_a_service_address_balance_not_enough", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "wallet_as_a_service_address_balance_not_enough" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Your address balance is insufficient to complete this action. Please check for any pending transaction requests or add more funds." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "CallbackUrlNotVerified": { "type": "object", "description": "callback_url_not_verified", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "callback_url_not_verified" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The Callback URL has not been verified. Please, verify the URL from within your Dashboard and try again." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InsufficientFrozenAmount": { "type": "object", "description": "insufficient_frozen_amount", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "insufficient_frozen_amount" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Address: {address} has insufficient frozen balance ({frozenBalance}TRX) for resource ({resource}) to unfreeze." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "MaximumUnfreezeOperationsReached": { "type": "object", "description": "maximum_unfreeze_operations_reached", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "maximum_unfreeze_operations_reached" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Address: {address} has reached its maximum unfreeze operations." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "NoWithdrawableBalance": { "type": "object", "description": "no_withdrawable_balance", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "no_withdrawable_balance" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Address: {address} doesn't have any balance to withdraw." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "DelegatedResourcesLocked": { "type": "object", "description": "delegated_resources_locked", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "delegated_resources_locked" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Delegation lock period has not expired yet for resources of type: {resource} for address: {toAddress}. Expiry times for the resources: {expireTimes}" }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "EncodeXRPAddressRI": { "type": "object", "properties": { "xAddress": { "type": "string", "description": "The X-address format that encodes the classic address.", "example": "T7zVRFzUcVxFfE3MUM6jV3SpobVdECBZ1K9UnX62Jacc6AV" } }, "required": [ "xAddress" ] }, "EncodeXRPAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/EncodeXRPAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "EncodeXRPAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "EncodeXRPAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" } ] }, "EncodeXRPAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "InvalidBlockchain": { "type": "object", "description": "invalid_blockchain", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_blockchain" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Invalid blockchain! Blockchain MUST be one of: {validBlockchains}" }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "InvalidNetwork": { "type": "object", "description": "invalid_network", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "invalid_network" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Invalid network! Network MUST be one of: {validNetworks}" }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "DecodeXRPAddressRI": { "type": "object", "properties": { "classicAddress": { "type": "string", "description": "The classic XRP Ledger address.", "example": "rB1QL2KsiwrwaErZ8Pa8dVh3ZEQ2oKGp9J" }, "tag": { "type": "string", "description": "A numeric identifier associated with an XRP Ledger address.", "example": "123" } }, "required": [ "classicAddress", "tag" ] }, "DecodeXRPAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/DecodeXRPAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "DecodeXRPAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "DecodeXRPAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" }, { "$ref": "#/components/schemas/InvalidBlockchain" }, { "$ref": "#/components/schemas/InvalidNetwork" } ] }, "DecodeXRPAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "CreateSingleTransferRI": { "type": "object", "properties": { "amountUnit": { "type": "string", "description": "Indicates the unit in which the transaction amount is expressed.", "example": "ETH" }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "gross": { "type": "boolean", "description": "Whether the amount is gross (fee deducted from amount).", "example": false }, "maxFee": { "type": "string", "description": "The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.", "example": "0.006" }, "note": { "type": "string", "description": "Transaction note with additional details.", "example": "yourAdditionalInformationhere" }, "recipients": { "type": "array", "description": "Destination of the transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Address of the destination.", "example": "0xbfe14b26d2680a232499f059d251f2486f32cdff" }, "addressTag": { "type": "integer", "description": "Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address.", "example": 67899 }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.001" }, "amountUnit": { "type": "string", "description": "Defines the unit of the received amount for the address, e.g. ETH, XRP, TRX, BNB.", "example": "ETH" }, "classicAddress": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the destinations address is an x-Address.", "example": "X7V5BG5S33VjkcpgywNsQohdPKfJ4a1svmJas9ffSfdAukx" }, "convertedAmountToUSD": { "type": "string", "description": "Amount calculated in USD", "example": "3.31" } }, "required": [ "address", "amount", "amountUnit", "convertedAmountToUSD" ] } }, "senders": { "type": "object", "description": "Defines details about the source, i.e. the sender.", "properties": { "address": { "type": "string", "description": "Sender's address.", "example": "0x2d7127f27a2ca399cb3e3217140adc88d1d71fae" }, "addressTag": { "type": "integer", "description": "Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address along with the Source Classic Address.", "example": 123 }, "classicAddress": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the source address is an x-Address.", "example": "XVVovbvpyQwcrzhQRL1VeVvjwzsM5EiKPrtvwcckinqkbZW" } }, "required": [ "address" ] }, "totalTransactionAmount": { "type": "string", "description": "Total amount of the transaction.", "example": "0.001" }, "transactionRequestId": { "type": "string", "description": "Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which `referenceId` concern that specific transaction request.", "example": "62daacdbc8a7282e9ea01c35" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction, e.g. \"created\".", "example": "created", "enum": [ "created" ] } }, "required": [ "amountUnit", "maxFee", "note", "recipients", "senders", "totalTransactionAmount", "transactionRequestId", "transactionRequestStatus" ] }, "CreateSingleTransferR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateSingleTransferRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateSingleTransferE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateSingleTransferE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateSingleTransferE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateSingleTransferE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceTokenNotSupported" }, { "$ref": "#/components/schemas/GrossAmountNotSupportedWithFeePayer" }, { "$ref": "#/components/schemas/GrossAmountOnlySupportedForCoins" } ] }, "WalletAsAServiceTokenNotSupported": { "type": "object", "description": "wallet_as_a_service_token_not_supported", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "wallet_as_a_service_token_not_supported" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "The token is not supported for this blockchain and network. To be supported, please contact our team." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType": { "type": "object", "description": "wallet_as_a_service_provided_network_is_not_suitable_for_this_wallet_type", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "wallet_as_a_service_provided_network_is_not_suitable_for_this_wallet_type" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "This wallet is not for the provided network." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "GrossAmountNotSupportedWithFeePayer": { "type": "object", "description": "gross_amount_not_supported_with_fee_payer", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "gross_amount_not_supported_with_fee_payer" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Gross amount is not supported when a fee payer is provided. The fee payer covers the transaction fee separately." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "GrossAmountOnlySupportedForCoins": { "type": "object", "description": "gross_amount_only_supported_for_coins", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "gross_amount_only_supported_for_coins" }, "message": { "type": "string", "description": "Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.", "example": "Gross amount is only supported for coin transactions. Token transaction fees are paid in the native coin and cannot be deducted from the token amount." }, "details": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Specifies an attribute of the error by name.", "example": "attribute which content caused the error" }, "message": { "type": "string", "description": "Specifies the details of an attribute as part from the error.", "example": "message describing the error" } }, "required": [ "attribute", "message" ] } } }, "required": [ "code", "message" ] }, "CreateMultipleTransferRI": { "type": "object", "properties": { "amountUnit": { "type": "string", "description": "Amount unit.", "example": "BTC" }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "gross": { "type": "boolean", "description": "Whether the amount is gross (fee deducted from amount).", "example": false }, "maxFee": { "type": "string", "description": "The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.", "example": "0.003" }, "note": { "type": "string", "description": "Transaction note with additional details.", "example": "yourExampleStringHere" }, "prepareStrategy": { "type": "string", "description": "UTXO prepare strategy used.", "example": "optimize-size", "enum": [ "minimize-dust", "optimize-size" ] }, "recipients": { "type": "array", "description": "Destinations of the transaction", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Address of the destination.", "example": "bc1qut6n59lceee7s94g5qme08yzu8evd2yfjuuu3k" }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.001" }, "amountUnit": { "type": "string", "description": "Defines the unit of the received amount for the address, e.g. BTC, LTC.", "example": "BTC" }, "convertedAmountToUSD": { "type": "string", "description": "Amount calculated in USD.", "example": "95.42" } }, "required": [ "address", "amount", "amountUnit", "convertedAmountToUSD" ] } }, "totalTransactionAmount": { "type": "string", "description": "Total amount of the transaction.", "example": "0.001" }, "transactionRequestId": { "type": "string", "description": "Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which `referenceId` concern that specific transaction request.", "example": "62daacdbc8a7282e9ea01c35" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction, e.g. \"created\".", "example": "created", "enum": [ "created", "await-approval", "pending", "prepared", "signed", "broadcasted", "success", "failed", "rejected", "mined", "mined-with-errors", "await-approval-l2" ] } }, "required": [ "amountUnit", "feePriority", "note", "prepareStrategy", "recipients", "totalTransactionAmount", "transactionRequestId", "transactionRequestStatus" ] }, "CreateMultipleTransferR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateMultipleTransferRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateMultipleTransferE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateMultipleTransferE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateMultipleTransferE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateMultipleTransferE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/GrossAmountNotSupportedWithFeePayer" } ] }, "ListTransactionsByVaultAccountRI": { "type": "object", "properties": { "blockchain": { "type": "string", "description": "The blockchain where the transaction occurred.", "example": "tron" }, "createdTimestamp": { "type": "integer", "description": "When this transaction was created.", "example": 1705399159 }, "direction": { "type": "string", "description": "Indicates the transaction direction relative to the vault account.", "example": "incoming" }, "hasTokenTransfer": { "type": "boolean", "description": "If this transaction has any tokens transfers.", "example": false }, "id": { "type": "string", "description": "The transaction ID in Vaultody, this is needed for pagination/load more functionality.", "example": "654ba3af9e8dd80901f17347" }, "isInternal": { "type": "boolean", "description": "If this transaction has any Internal Transactions.", "example": false }, "minedInBlockHeight": { "type": "string", "description": "Block height where the transaction was confirmed.", "example": "1234324" }, "network": { "type": "string", "description": "Specific blockchain network used.", "example": "mainnet" }, "recipients": { "type": "array", "description": "Recipients are all addresses receive assets in this transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Blockchain address receiving the asset.", "example": "tb1q7yqnaw9skttgh99n32r0kzr68mt8ejnm0qfec2" }, "addressType": { "type": "string", "description": "Type of address within the system (e.g., deposit)", "example": "deposit" }, "amount": { "type": "string", "description": "Amount of the asset transferred to this recipient.", "example": "0.0002" }, "amountUnit": { "type": "string", "description": "Amount unit (e.g., BTC, ETH, LTC, USDC).", "example": "BTC" }, "isVaultAddress": { "type": "boolean", "description": "If this address belongs to this Vault account or not.", "example": true }, "label": { "type": "string", "description": "Human-readable label associated with the address.", "example": "BTC address" } }, "required": [ "address", "addressType", "amount", "amountUnit", "isVaultAddress", "label" ] } }, "senders": { "type": "array", "description": "Senders are all addresses send assets in this transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Blockchain address sending the asset.", "example": "tb1qavgzj3a8n34hq2rgmf8mngal0spp3kmpz6m6lw" }, "amount": { "type": "string", "description": "Amount of the asset sent from this address.", "example": "0.0002" }, "amountUnit": { "type": "string", "description": "Symbol representing the asset being transferred.", "example": "BTC" }, "isVaultAddress": { "type": "boolean", "description": "If this address belongs to this Vault accunt or not.", "example": false }, "label": { "type": "string", "description": "Label for identifying the address.", "example": "Address name" } }, "required": [ "address", "amount", "amountUnit", "isVaultAddress", "label" ] } }, "status": { "type": "string", "description": "The status of this transaction.", "example": "confirmed" }, "transactionFee": { "type": "object", "description": "The transaction fee.", "properties": { "amount": { "type": "string", "description": "The transaction fee amount.", "example": "5.96124" }, "amountUnit": { "type": "string", "description": "The transaction fee amount unit.", "example": "BTC" } }, "required": [ "amount", "amountUnit" ] }, "transactionId": { "type": "string", "description": "Blockchain transaction hash identifying the transaction on the network.", "example": "281a63d28ddf6d0d5d78090b7cdf3a8c0be95bbb296544943ef45d9dec44405d" } }, "required": [ "blockchain", "createdTimestamp", "direction", "hasTokenTransfer", "id", "isInternal", "minedInBlockHeight", "network", "recipients", "senders", "status", "transactionFee", "transactionId" ] }, "ListTransactionsByVaultAccountR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByVaultAccountRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByVaultAccountE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByVaultAccountE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByVaultAccountE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GasSponsorshipTransferRI": { "type": "object", "properties": { "amountUnit": { "type": "string", "description": "Indicates the unit in which the transaction amount is expressed.", "example": "ETH" }, "feePayer": { "type": "string", "description": "Address that will cover for the fee.", "example": "0x92b23f96a3beeba16d5378709d8ca2ec0be5615f" }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "maxFee": { "type": "string", "description": "The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.", "example": "0.006" }, "note": { "type": "string", "description": "Transaction note with additional details.", "example": "yourAdditionalInformationhere" }, "recipients": { "type": "array", "description": "Destination of the transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Address of the destination.", "example": "0xbfe14b26d2680a232499f059d251f2486f32cdff" }, "addressTag": { "type": "integer", "description": "Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address.", "example": 67899 }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.001" }, "amountUnit": { "type": "string", "description": "Defines the unit of the received amount for the address, e.g. ETH, XRP, TRX, BNB.", "example": "ETH" }, "classicAddress": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the destinations address is an x-Address.", "example": "X7V5BG5S33VjkcpgywNsQohdPKfJ4a1svmJas9ffSfdAukx" }, "convertedAmountToUSD": { "type": "string", "description": "Amount calculated in USD", "example": "3.31" } }, "required": [ "address", "amount", "amountUnit", "convertedAmountToUSD" ] } }, "senders": { "type": "object", "description": "Defines details about the source, i.e. the sender.", "properties": { "address": { "type": "string", "description": "Sender's address.", "example": "0x2d7127f27a2ca399cb3e3217140adc88d1d71fae" }, "addressTag": { "type": "integer", "description": "Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address along with the Source Classic Address.", "example": 123 }, "classicAddress": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the source address is an x-Address.", "example": "XVVovbvpyQwcrzhQRL1VeVvjwzsM5EiKPrtvwcckinqkbZW" } }, "required": [ "address" ] }, "totalTransactionAmount": { "type": "string", "description": "Total amount of the transaction.", "example": "0.001" }, "transactionRequestId": { "type": "string", "description": "Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which `referenceId` concern that specific transaction request.", "example": "62daacdbc8a7282e9ea01c35" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction, e.g. \"created\".", "example": "created", "enum": [ "created" ] } }, "required": [ "amountUnit", "feePayer", "maxFee", "note", "recipients", "senders", "totalTransactionAmount", "transactionRequestId", "transactionRequestStatus" ] }, "GasSponsorshipTransferR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GasSponsorshipTransferRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GasSponsorshipTransferE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GasSponsorshipTransferE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GasSponsorshipTransferE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "GasSponsorshipTransferE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceTokenNotSupported" } ] }, "CreateBatchTransactionRequestRI": { "type": "object", "properties": { "amountUnit": { "type": "string", "description": "Indicates the unit in which the transaction amount is expressed.", "example": "ETH" }, "feePayer": { "type": "string", "description": "Address that will cover for the fee.", "example": "0xa5bd60af2ed1499ce8292bb2e6c0179dcea34f33" }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "note": { "type": "string", "description": "Transaction note with additional details.", "example": "yourAdditionalInformationhere" }, "recipients": { "type": "array", "description": "Destination of the transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Address of the destination.", "example": "0xd2070342a1a5ce24930ec6582b3db846458525a0" }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.001" }, "amountUnit": { "type": "string", "description": "Defines the unit of the received amount for the address, e.g. ETH, BTC, TRX, BNB.", "example": "ETH" }, "assetId": { "type": "string", "description": "Asset identifier being transferred.", "example": "6913471c6b2794841dc8fb7e" }, "convertedAmountToUSD": { "type": "string", "description": "Amount calculated in USD.", "example": "3.31" } }, "required": [ "address", "amount", "amountUnit", "assetId", "convertedAmountToUSD" ] } }, "senders": { "type": "object", "description": "Source of the transaction,", "properties": { "address": { "type": "string", "description": "Addresses of the sources", "example": "0x9b08125f3fb134f0ebb462ccff0f463bcfb4f623" } }, "required": [ "address" ] }, "totalTransactionAmountInUsd": { "type": "string", "description": "Total amount of the transaction in USD.", "example": "3.31" }, "transactionRequestId": { "type": "string", "description": "Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which `referenceId` concern that specific transaction request.", "example": "6980695689a82e0ff4f7edc7" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction, e.g. \"created\".", "example": "created", "enum": [ "created", "await-approval", "pending", "prepared", "signed", "broadcasted", "success", "failed", "rejected", "mined", "mined-with-errors", "await-approval-l2", "pending-signing" ] } }, "required": [ "amountUnit", "feePayer", "feePriority", "note", "recipients", "senders", "totalTransactionAmountInUsd", "transactionRequestId", "transactionRequestStatus" ] }, "CreateBatchTransactionRequestR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateBatchTransactionRequestRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateBatchTransactionRequestE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateBatchTransactionRequestE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateBatchTransactionRequestE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateBatchTransactionRequestE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceTokenNotSupported" } ] }, "GetTransactionDetailsRI": { "type": "object", "properties": { "dateTime": { "type": "integer", "description": "Defines the specific UNIX time when the transaction was created.", "example": 1704881727 }, "direction": { "type": "string", "description": "The direction of a transaction, e.g incoming, outgoing, client-internal, vault-internal, internal.", "example": "incoming" }, "internalTransfers": { "type": "array", "description": "Information about internal transfers within a transaction.", "items": { "type": "object", "properties": { "fromAddress": { "type": "string", "description": "The sender's address for the internal transfer.", "example": "0xdd06a8b5d79fa90cc4417a66de597eaa97eb141e" }, "operationId": { "type": "string", "description": "The ID of the operation.", "example": "call_0_1_0" }, "operationType": { "type": "string", "description": "The type of operation being performed within the transaction. It provides information about the nature of the action being executed.", "example": "CALL" }, "previousTxHash": { "type": "string", "description": "The hash of the transaction that occurred immediately before the current transaction within the blockchain.", "example": "0xf2c396008015d3331f0ca54247609af92a0b2c442843a69e10965341659d21d4" }, "timestamp": { "type": "integer", "description": "Time when the transaction was recorded on the blockchain.", "example": 1701435851 }, "toAddress": { "type": "string", "description": "The receiver's address for the internal transfer.", "example": "0x267be1c1d684f78cb4f6a176c4911b741e4ffdc0" } }, "required": [ "fromAddress", "operationId", "operationType", "previousTxHash", "timestamp", "toAddress" ] } }, "minedInBlockHeight": { "type": "string", "description": "Represents the hash of the block where this transaction was mined/confirmed for first time.", "example": "1234324" }, "network": { "type": "string", "description": "The specific network, e.g mainnet, testnet, sepolia, nile.", "example": "testnet" }, "recipients": { "type": "array", "description": "Information about recipients.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Recipient's address.", "example": "mku7JSyfdtKNEQb9J6aegZysX7iPWhWcp7" }, "addressType": { "type": "string", "description": "Represents the address type, e.g deposit, smart.", "example": "deposit" }, "amount": { "type": "string", "description": "Amount received.", "example": "0.0000546" }, "amountUnit": { "type": "string", "description": "Symbol of the unit e.g. BTC, TRX, ETH.", "example": "BTC" }, "isVaultAddress": { "type": "string", "description": "Indicates if the address belongs to the vault (true/false).", "example": "true" }, "label": { "type": "string", "description": "Label of the address.", "example": "Bitcoin address" } }, "required": [ "address", "amount", "amountUnit", "isVaultAddress" ] } }, "senders": { "type": "array", "description": "Information about senders.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Sender's address.", "example": "n1osMwQ7oy8qr2BrmNZ6mfCBjpfZJQGmEU" }, "addressType": { "type": "string", "description": "Represents the address type, e.g deposit.", "example": "deposit" }, "amount": { "type": "string", "description": "Amount sent.", "example": "0.0000546" }, "amountUnit": { "type": "string", "description": "Symbol of the unit e.g. BTC, TRX, ETH.", "example": "BTC" }, "isVaultAddress": { "type": "string", "description": "Indicates if the address belongs to the vault.", "example": "true" }, "label": { "type": "string", "description": "Label of the address.", "example": "Bitcoin address" } }, "required": [ "address", "amount", "amountUnit", "isVaultAddress" ] } }, "status": { "type": "string", "description": "Transaction status, e.g. confirmed, faild.", "example": "confirmed" }, "tokensTransfers": { "type": "array", "description": "Information about token transaction, in case it is about token.", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount of tokens transferred.", "example": "50000" }, "amountUnit": { "type": "string", "description": "Symbol of the token, e.g. JST, USDT, USDC.", "example": "USDT" }, "contractAddress": { "type": "string", "description": "Contract address of the token.", "example": "TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj" }, "decimals": { "type": "integer", "description": "The number of decimal places that a token can be divided into.", "example": 18 }, "fromAddress": { "type": "string", "description": "Sender's address.", "example": "TVF2Mp9QY7FEGTnr3DBpFLobA6jguHyMvi" }, "toAddress": { "type": "string", "description": "Receiver's address.", "example": "TS1nMMDbKMFCNfdCBmQLiaA5VUdrG31kra" }, "tokenName": { "type": "string", "description": "Name of the token, e.g. Tether, JUST, USD Coin.", "example": "Tether USD" }, "type": { "type": "string", "description": "Type of token e.g. TRC-20, BEP-20,", "example": "TRC-20" } }, "required": [ "amount", "amountUnit", "contractAddress", "decimals", "fromAddress", "toAddress", "tokenName", "type" ] } }, "transactionFee": { "type": "object", "description": "Transaction fee information.", "properties": { "amount": { "type": "string", "description": "Amount of transaction fee.", "example": "5.96124" }, "amountUnit": { "type": "string", "description": "Symbol of the unit e.g. BTC, TRX, ETH, BNB.", "example": "BTC" } }, "required": [ "amount", "amountUnit" ] } }, "required": [ "dateTime", "direction", "minedInBlockHeight", "network", "recipients", "senders", "status", "transactionFee" ] }, "GetTransactionDetailsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTransactionDetailsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTransactionDetailsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTransactionDetailsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTransactionDetailsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "EstimateApproximateTransactionFeeByAssetIDRI": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "The message of the error if such occurred.", "example": "INSUFFICIENT_FUNDS" }, "feeInNative": { "type": "string", "description": "The calculated fee.", "example": "0.00001698" }, "maxAmount": { "type": "string", "description": "For UTXO based transactions. The max amount you can send from the vault account.", "example": "10" } }, "required": [ "errorMessage", "feeInNative", "maxAmount" ] }, "EstimateApproximateTransactionFeeByAssetIDR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/EstimateApproximateTransactionFeeByAssetIDRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "EstimateApproximateTransactionFeeByAssetIDE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "EstimateApproximateTransactionFeeByAssetIDE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "EstimateApproximateTransactionFeeByAssetIDE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "TransactionRequest": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Type of webhook event: TRANSACTION_REQUEST indicates a new transaction request has been created and is pending approval or rejection.", "example": "TRANSACTION_REQUEST" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "unit": { "type": "string", "description": "The specific asset unit.", "example": "BTC" }, "requestId": { "type": "string", "description": "A unique identifier for the original transaction request that initiated this outgoing transaction.", "example": "686cd2860ca2f4fd25f77099" }, "transactionType": { "type": "string", "description": "The type of asset being transferred: COIN, TOKEN, LINKING, SMART_COIN, SMART_TOKEN, FREEZE, UNFREEZE, DELEGATE, UNDELEGATE, WITHDRAW_RESOURCE,BATCH.", "example": "COIN" } }, "required": [ "vaultAccountId", "assetId", "unit", "requestId", "transactionType" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "TransactionApproved": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "The type of event: TRANSACTION_APPROVED means the transaction has met the required number of approvals and is now eligible to be broadcast to the blockchain.", "example": "TRANSACTION_APPROVED" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "unit": { "type": "string", "description": "The specific asset unit.", "example": "BTC" }, "requestId": { "type": "string", "description": "A unique identifier for the original transaction request that initiated this outgoing transaction.", "example": "686cd2860ca2f4fd25f77099" }, "transactionType": { "type": "string", "description": "The type of asset being transferred: COIN, TOKEN, LINKING, SMART_COIN, SMART_TOKEN, FREEZE, UNFREEZE, DELEGATE, UNDELEGATE, WITHDRAW_RESOURCE,BATCH.", "example": "COIN" }, "requiredApprovals": { "type": "integer", "description": "Number of required approvals for this transaction to proceed.", "example": 1 }, "requiredRejections": { "type": "integer", "description": "Number of rejections needed to cancel the transaction.", "example": 1 }, "currentApprovals": { "type": "integer", "description": "Current number of approvals received for the transaction.", "example": 1 }, "currentRejections": { "type": "integer", "description": "Current number of rejections received for the transaction.", "example": 0 } }, "required": [ "vaultAccountId", "assetId", "unit", "requestId", "transactionType", "requiredApprovals", "requiredRejections", "currentApprovals", "currentRejections" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "TransactionRejected": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "The event type - TRANSACTION_REJECTED indicates that the transaction was rejected.", "example": "TRANSACTION_REJECTED" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "unit": { "type": "string", "description": "The specific asset unit.", "example": "BTC" }, "requestId": { "type": "string", "description": "A unique identifier for the original transaction request that initiated this outgoing transaction.", "example": "686cd2860ca2f4fd25f77099" }, "transactionType": { "type": "string", "description": "The type of asset being transferred: COIN, TOKEN, LINKING, SMART_COIN, SMART_TOKEN, FREEZE, UNFREEZE, DELEGATE, UNDELEGATE, WITHDRAW_RESOURCE,BATCH.", "example": "COIN" }, "requiredApprovals": { "type": "integer", "description": "Number of required approvals for this transaction to proceed.", "example": 1 }, "requiredRejections": { "type": "integer", "description": "Number of rejections needed to cancel the transaction.", "example": 1 }, "currentApprovals": { "type": "integer", "description": "Current number of approvals received for the transaction.", "example": 0 }, "currentRejections": { "type": "integer", "description": "Current number of rejections received for the transaction.", "example": 1 } }, "required": [ "vaultAccountId", "assetId", "unit", "requestId", "transactionType", "requiredApprovals", "requiredRejections", "currentApprovals", "currentRejections" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "TransactionBroadcasted": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "The name of the event that triggered the webhook. TRANSACTION_BROADCASTED indicates the transaction has been broadcast to the blockchain network, but not yet mined", "example": "TRANSACTION_BROADCASTED" }, "item": { "type": "object", "description": "Contains detailed information about the transaction that was broadcast.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "unit": { "type": "string", "description": "The specific asset unit.", "example": "BTC" }, "requestId": { "type": "string", "description": "A unique identifier for the original transaction request that initiated this outgoing transaction.", "example": "686cd2860ca2f4fd25f77099" }, "transactionType": { "type": "string", "description": "The type of asset being transferred: COIN, TOKEN, LINKING, SMART_COIN, SMART_TOKEN, FREEZE, UNFREEZE, DELEGATE, UNDELEGATE, WITHDRAW_RESOURCE,BATCH.", "example": "COIN" }, "requiredApprovals": { "type": "integer", "description": "Number of required approvals for this transaction to proceed.", "example": 1 }, "requiredRejections": { "type": "integer", "description": "Number of rejections needed to cancel the transaction.", "example": 1 }, "currentApprovals": { "type": "integer", "description": "Current number of approvals received for the transaction.", "example": 1 }, "currentRejections": { "type": "integer", "description": "Current number of rejections received for the transaction.", "example": 0 }, "transactionId": { "type": "string", "description": "Blockchain-specific transaction hash identifying the mined transaction.", "example": "37c2e0696bd86df5010bafa1a4c22ce1b070a8c32126b421ededa0e4efb50623" } }, "required": [ "vaultAccountId", "assetId", "unit", "requestId", "transactionType", "requiredApprovals", "requiredRejections", "currentApprovals", "currentRejections", "transactionId" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "OutgoingMined": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms..", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Type of event that triggered the webhook. OUTGOING_MINED means an outgoing transaction from the wallet has been mined.", "example": "OUTGOING_MINED" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "unit": { "type": "string", "description": "The specific asset unit.", "example": "BTC" }, "requestId": { "type": "string", "description": "A unique identifier for the original transaction request that initiated this outgoing transaction.", "example": "686cd2860ca2f4fd25f77099" }, "transactionType": { "type": "string", "description": "The type of asset being transferred: COIN, TOKEN, LINKING, SMART_COIN, SMART_TOKEN, FREEZE, UNFREEZE, DELEGATE, UNDELEGATE, WITHDRAW_RESOURCE, BATCH.", "example": "COIN" }, "requiredApprovals": { "type": "integer", "description": "Number of required approvals for this transaction to proceed.", "example": 1 }, "requiredRejections": { "type": "integer", "description": "Number of rejections needed to cancel the transaction.", "example": 1 }, "currentApprovals": { "type": "integer", "description": "Current number of approvals received for the transaction.", "example": 1 }, "currentRejections": { "type": "integer", "description": "Current number of rejections received for the transaction.", "example": 0 }, "transactionId": { "type": "string", "description": "Blockchain-specific transaction hash identifying the mined transaction.", "example": "37c2e0696bd86df5010bafa1a4c22ce1b070a8c32126b421ededa0e4efb50623" } }, "required": [ "vaultAccountId", "assetId", "unit", "requestId", "transactionType", "requiredApprovals", "requiredRejections", "currentApprovals", "currentRejections", "transactionId" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "OutgoingMinedWithErrors": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Name of the webhook event - OUTGOING_MINED_WITH_ERRORS, meaning the transaction was mined but did not succeed.", "example": "OUTGOING_MINED_WITH_ERRORS" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "unit": { "type": "string", "description": "The specific asset unit.", "example": "BTC" }, "requestId": { "type": "string", "description": "A unique identifier for the original transaction request that initiated this outgoing transaction.", "example": "686cd2860ca2f4fd25f77099" }, "transactionType": { "type": "string", "description": "The type of asset being transferred: COIN or TOKEN.", "example": "COIN" }, "requiredApprovals": { "type": "integer", "description": "Number of required approvals for this transaction to proceed.", "example": 1 }, "requiredRejections": { "type": "integer", "description": "Number of rejections needed to cancel the transaction.", "example": 1 }, "currentApprovals": { "type": "integer", "description": "Current number of approvals received for the transaction.", "example": 1 }, "currentRejections": { "type": "integer", "description": "Current number of rejections received for the transaction.", "example": 0 }, "failedReason": { "type": "string", "description": "A short explanation of why the transaction failed despite being mined.", "example": "Failure" } }, "required": [ "vaultAccountId", "assetId", "unit", "requestId", "transactionType", "requiredApprovals", "requiredRejections", "currentApprovals", "currentRejections", "failedReason" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "OutgoingFailed": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Event type: OUTGOING_FAILED indicates that an attempted outgoing transaction has failed.", "example": "OUTGOING_FAILED" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "unit": { "type": "string", "description": "The specific asset unit.", "example": "BTC" }, "requestId": { "type": "string", "description": "A unique identifier for the original transaction request that initiated this outgoing transaction.", "example": "686cd2860ca2f4fd25f77099" }, "transactionType": { "type": "string", "description": "The type of asset being transferred: COIN, TOKEN, LINKING, SMART_COIN, SMART_TOKEN, FREEZE, UNFREEZE, DELEGATE, UNDELEGATE, WITHDRAW_RESOURCE,BATCH.", "example": "COIN" }, "requiredApprovals": { "type": "integer", "description": "Number of required approvals for this transaction to proceed.", "example": 1 }, "requiredRejections": { "type": "integer", "description": "Number of rejections needed to cancel the transaction.", "example": 1 }, "currentApprovals": { "type": "integer", "description": "Current number of approvals received for the transaction.", "example": 1 }, "currentRejections": { "type": "integer", "description": "Current number of rejections received for the transaction.", "example": 0 }, "failedReason": { "type": "string", "description": "Reason code indicating why the transaction failed.", "example": "INSUFFICIENT_FUNDS" } }, "required": [ "vaultAccountId", "assetId", "unit", "requestId", "transactionType", "requiredApprovals", "requiredRejections", "currentApprovals", "currentRejections", "failedReason" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "CoinTransaction": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Type of event that triggered the webhook.", "example": "INCOMING_MINED_TX" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "address": { "type": "string", "description": "Destination address receiving the funds.", "example": "tb1q3ft8aq4daesecw8yfz0gt4hgursm0l6nhj06m9" }, "minedInBlock": { "type": "object", "description": "Information about the block that mined this transaction.", "properties": { "height": { "type": "integer", "description": "Block height where transaction was mined.", "example": 4547001 }, "hash": { "type": "string", "description": "The hash of the block containing the transaction.", "example": "0000000000000004a25a24749cbca4ac6b2d62b9932f0fefbb9cb8a7a9e5619e" }, "timestamp": { "type": "integer", "description": "UNIX timestamp indicating when the block was mined.", "example": 1750837928 } }, "required": [ "height", "hash", "timestamp" ] }, "direction": { "type": "string", "description": "Direction of the transaction (eg. incoming, outgoing, client-internal, vault-internal)", "example": "incoming" }, "currentConfirmations": { "type": "integer", "description": "Number of confirmations the transaction currently has.", "example": 1 }, "targetConfirmations": { "type": "integer", "description": "The number of confirmations required for the transaction to be considered final (typically 6 for Bitcoin).", "example": 6 }, "amount": { "type": "string", "description": "The amount of the asset received in the transaction.", "example": "0.00000546" }, "unit": { "type": "string", "description": "The currency unit of the amount .", "example": "BTC" }, "transactionId": { "type": "string", "description": "Blockchain-specific transaction hash identifying the mined transaction.", "example": "cf0d9a82045c13dba627788d9508b3dfd761e46b49deba48d004c82e2f2f83f2" }, "status": { "type": "string", "description": "Status of transaction if it is success or failed.", "example": "success" } }, "required": [ "vaultAccountId", "assetId", "address", "minedInBlock", "direction", "currentConfirmations", "targetConfirmations", "amount", "unit", "transactionId", "status" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "TokenTransaction": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.1", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Type of event that triggered the webhook.", "example": "INCOMING_MINED_TX" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "address": { "type": "string", "description": "Destination address receiving the funds.", "example": "0xb65f76f9eeaebce98fda00300189221d10f2daef" }, "minedInBlock": { "type": "object", "description": "Information about the block that mined this transaction.", "properties": { "height": { "type": "integer", "description": "Block height where transaction was mined.", "example": 4547001 }, "hash": { "type": "string", "description": "The hash of the block containing the transaction.", "example": "0xe8232b0e50f9d18a53dd2eae5148275e86afe7ed2730c16bf58cf28566165afa" }, "timestamp": { "type": "integer", "description": "UNIX timestamp indicating when the block was mined.", "example": 1750837928 } }, "required": [ "height", "hash", "timestamp" ] }, "direction": { "type": "string", "description": "Direction of the transaction (eg. incoming, outgoing, client-internal, vault-internal)", "example": "incoming" }, "currentConfirmations": { "type": "integer", "description": "Number of confirmations the transaction currently has.", "example": 1 }, "targetConfirmations": { "type": "integer", "description": "The number of confirmations required for the transaction to be considered final.", "example": 12 }, "tokenType": { "type": "string", "description": "Type of token.", "example": "BEP-20" }, "transactionId": { "type": "string", "description": "Blockchain-specific transaction hash identifying the mined transaction.", "example": "37c2e0696bd86df5010bafa1a4c22ce1b070a8c32126b421ededa0e4efb50623" }, "status": { "type": "string", "description": "Status of transaction if it is success or failed.", "example": "success" }, "token": { "type": "object", "description": "Metadata about the token that was transferred.", "properties": { "tokenName": { "type": "string", "description": "The name of the token.", "example": "USDT" }, "tokenSymbol": { "type": "string", "description": "The symbol of the token.", "example": "USDT" }, "decimals": { "type": "integer", "description": "Number of decimal places the token uses.", "example": 6 }, "tokensAmount": { "type": "string", "description": "Amount of tokens transferred.", "example": "0.05" }, "contract": { "type": "string", "description": "Defines the contract address in the blockchain.", "example": "0x337610d27c682e347c9cd60bd4b3b107c9d34ddd" } }, "required": [ "tokenName", "tokenSymbol", "decimals", "tokensAmount", "contract" ] } }, "required": [ "vaultAccountId", "assetId", "address", "minedInBlock", "direction", "currentConfirmations", "targetConfirmations", "tokenType", "transactionId", "status", "token" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "InternalTransaction": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Type of event that triggered the webhook.", "example": "INCOMING_MINED_TX" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "address": { "type": "string", "description": "Destination address receiving the funds.", "example": "0x52942ee83d9c2aa18b92a7b01cfb3de94bf62462" }, "minedInBlock": { "type": "object", "description": "Information about the block that mined this transaction.", "properties": { "height": { "type": "integer", "description": "Block height where transaction was mined.", "example": 57758107 }, "hash": { "type": "string", "description": "The hash of the block containing the transaction.", "example": "0x97d27d49b1bb354a58ed127c72a15eadd7bb1c9c03647590335ca672d96247f6" }, "timestamp": { "type": "integer", "description": "UNIX timestamp indicating when the block was mined.", "example": 1750837928 } }, "required": [ "height", "hash", "timestamp" ] }, "direction": { "type": "string", "description": "Direction of the transaction (eg. incoming, outgoing, client-internal, vault-internal)", "example": "incoming" }, "currentConfirmations": { "type": "integer", "description": "Number of confirmations the transaction currently has.", "example": 1 }, "targetConfirmations": { "type": "integer", "description": "The number of confirmations required for the transaction to be considered final.", "example": 12 }, "amount": { "type": "string", "description": "The amount of the asset received in the transaction.", "example": "0.2" }, "unit": { "type": "string", "description": "The currency unit of the amount .", "example": "BNB" }, "parentTransactionId": { "type": "string", "description": "Hash of the parent transaction that caused this internal transaction.", "example": "0x429b83c010658d22d61d14eac5f38627355a2b9337154037512343fe599e2368" }, "operationId": { "type": "string", "description": "Type of internal operation.", "example": "call" }, "status": { "type": "string", "description": "Status of transaction if it is success or failed.", "example": "success" } }, "required": [ "vaultAccountId", "assetId", "address", "minedInBlock", "direction", "currentConfirmations", "targetConfirmations", "amount", "unit", "parentTransactionId", "operationId", "status" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "IncomingConfirmedCoinTx": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Type of event — INCOMING_CONFIRMED_COIN_TX indicates an incoming coin transaction has reached the required confirmations and is now considered final.", "example": "INCOMING_CONFIRMED_COIN_TX" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "address": { "type": "string", "description": "The receiving address.", "example": "tb1q3ft8aq4daesecw8yfz0gt4hgursm0l6nhj06m9" }, "minedInBlock": { "type": "object", "description": "Metadata about the block in which the transaction was mined.", "properties": { "height": { "type": "integer", "description": "Block height at which the transaction was mined.", "example": 4547001 }, "hash": { "type": "string", "description": "The hash of the block containing the transaction.", "example": "0000000000000004a25a24749cbca4ac6b2d62b9932f0fefbb9cb8a7a9e5619e" }, "timestamp": { "type": "integer", "description": "UNIX timestamp indicating when the block was mined.", "example": 1750837928 } }, "required": [ "height", "hash", "timestamp" ] }, "currentConfirmations": { "type": "integer", "description": "Number of confirmations the transaction currently has.", "example": 6 }, "targetConfirmations": { "type": "integer", "description": "The number of confirmations required for the transaction to be considered final (typically 6 for Bitcoin).", "example": 6 }, "amount": { "type": "string", "description": "The amount of the asset received in the transaction.", "example": "0.00000546" }, "unit": { "type": "string", "description": "The currency unit of the amount .", "example": "BTC" }, "transactionId": { "type": "string", "description": "Blockchain-specific transaction hash identifying the mined transaction.", "example": "cf0d9a82045c13dba627788d9508b3dfd761e46b49deba48d004c82e2f2f83f2" }, "status": { "type": "string", "description": "Status of transaction if it is success or failed.", "example": "success" } }, "required": [ "vaultAccountId", "assetId", "address", "minedInBlock", "currentConfirmations", "targetConfirmations", "amount", "unit", "transactionId", "status" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "IncomingConfirmedTokenTx": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "Name of the event: INCOMING_CONFIRMED_TOKEN_TX, indicating an incoming token transfer has reached finality.", "example": "INCOMING_CONFIRMED_TOKEN_TX" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "address": { "type": "string", "description": "The destination address that received the token transfer.", "example": "0x8deafae22f7dda381d1a8823c88d1df6df2c57f5" }, "minedInBlock": { "type": "object", "description": "Metadata about the block that includes this transaction.", "properties": { "height": { "type": "integer", "description": "The block height at which the transaction was mined.", "example": 8489747 }, "hash": { "type": "string", "description": "Hash of the block in which the transaction was confirmed.", "example": "0x57c8a3f77617223daae0033df3e8af26ecb6a1d1b70d898c292e42c551740f77" }, "timestamp": { "type": "integer", "description": "UNIX timestamp of when the block was mined.", "example": 1749216456 } }, "required": [ "height", "hash", "timestamp" ] }, "currentConfirmations": { "type": "integer", "description": "The current number of confirmations for the transaction.", "example": 7 }, "targetConfirmations": { "type": "integer", "description": "Number of confirmations required for the transaction to be considered final.", "example": 12 }, "tokenType": { "type": "string", "description": "Type of token.", "example": "ERC-20" }, "transactionId": { "type": "string", "description": "Blockchain-specific transaction hash identifying the mined transaction.", "example": "37c2e0696bd86df5010bafa1a4c22ce1b070a8c32126b421ededa0e4efb50623" }, "status": { "type": "string", "description": "Status of transaction if it is success or failed.", "example": "success" }, "token": { "type": "object", "description": "Metadata about the token that was transferred.", "properties": { "tokenName": { "type": "string", "description": "The name of the token.", "example": "USDC" }, "tokenSymbol": { "type": "string", "description": "The symbol of the token.", "example": "USDC" }, "decimals": { "type": "integer", "description": "Number of decimal places the token uses (e.g., 6 for USDC).", "example": 6 }, "tokensAmount": { "type": "string", "description": "Amount of tokens transferred.", "example": "0.003" }, "contract": { "type": "string", "description": "Defines the contract address in the blockchain.", "example": "0x534bD102153EF199abAe8296a2FaE4599fC44Cdc" } }, "required": [ "tokenName", "tokenSymbol", "decimals", "tokensAmount", "contract" ] } }, "required": [ "vaultAccountId", "assetId", "address", "minedInBlock", "currentConfirmations", "targetConfirmations", "tokenType", "transactionId", "status", "token" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] }, "IncomingConfirmedInternalTx": { "type": "object", "properties": { "walletId": { "type": "string", "description": "Unique identifier of the wallet associated with the transaction.", "example": "685121237d7d1e0007ac1a1d" }, "webhookId": { "type": "string", "description": "Unique identifier of the webhook that triggered this callback.", "example": "68516e9c6620b0a4790ed541" }, "idempotencyKey": { "type": "string", "description": "A unique key used to prevent duplicate processing of this callback if it's sent more than once.", "example": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9" }, "apiVersion": { "type": "string", "description": "The version of the API that this webhook callback conforms.", "example": "2025-09-23" }, "data": { "type": "object", "description": "Contains the event type and all related transaction information.", "properties": { "event": { "type": "string", "description": "The type of webhook event - INCOMING_CONFIRMED_INTERNAL_TX, meaning an internal transaction has been mined and reached the required confirmations.", "example": "INCOMING_CONFIRMED_INTERNAL_TX" }, "item": { "type": "object", "description": "Contains detailed metadata about the outgoing mined transaction.", "properties": { "vaultAccountId": { "type": "string", "description": "The specific vault account id.", "example": "69ba58c529eb49000746b311" }, "assetId": { "type": "string", "description": "The specific asset id.", "example": "6913471c6b2794841dc8fb6f" }, "address": { "type": "string", "description": "The recipient address of the internal transaction.", "example": "0xd2070342a1a5ce24930ec6582b3db846458525a0" }, "minedInBlock": { "type": "object", "description": "Metadata about the block containing this transaction.", "properties": { "height": { "type": "integer", "description": "Block number in which the transaction was confirmed.", "example": 8375151 }, "hash": { "type": "string", "description": "The hash of the block containing the transaction.", "example": "0xc2764753cdd84cc6b6c7e57bf46292b5dbd072f4575d3c3d1d4e2af3bcad30db" }, "timestamp": { "type": "integer", "description": "UNIX timestamp of when the block was mined.", "example": 1747833120 } }, "required": [ "height", "hash", "timestamp" ] }, "currentConfirmations": { "type": "integer", "description": "Number of confirmations the transaction currently has.", "example": 7 }, "targetConfirmations": { "type": "integer", "description": "Number of confirmations required for finality.", "example": 12 }, "amount": { "type": "string", "description": "Amount of the transfer.", "example": "0.005" }, "unit": { "type": "string", "description": "Unit of currency.", "example": "ETH" }, "parentTransactionId": { "type": "string", "description": "Hash of the parent transaction that caused this internal transaction.", "example": "0x28e4d131687b1841282ccb84cf00ed13ca6b88ed3c9eae8f0795f356e5ec4367" }, "operationId": { "type": "string", "description": "Type of internal operation.", "example": "call" }, "status": { "type": "string", "description": "Status of transaction if it is success or failed.", "example": "success" } }, "required": [ "vaultAccountId", "assetId", "address", "minedInBlock", "currentConfirmations", "targetConfirmations", "amount", "unit", "parentTransactionId", "operationId", "status" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] } } }, "security": [ { "ApiKey": [], "ApiSign": [], "ApiTimestamp": [], "ApiPassphrase": [] } ], "info": { "title": "Vaultody", "version": "2026-03-20", "description": "Vaultody", "termsOfService": "https://vaultody.com/terms-conditions", "contact": { "name": "Vaultody Team", "url": "https://vaultody.com/", "email": "developers@vaultody.com" }, "license": { "name": "MIT", "url": "http://www.opensource.org/licenses/mit-license.php" } }, "tags": [ { "name": "Getting Started", "description": "## Introduction\r\nVaultody is a secure digital asset management platform built on Multi-Party Computation (MPC). Our REST API lets you integrate institutional-grade custody directly into your application — enabling you to receive crypto deposits, send withdrawals, manage wallets, and track transactions across 17 blockchains without ever handling a private key.\r\nThis page will get you from zero to your first successful API call in minutes.\r\n\r\n## Before You Begin\r\nMake sure you have the following before proceeding:\r\n\r\nA Vaultody account — [sign up here](http://app.vaultody.com/register)\r\nA Vault must be created in the Dashboard (Dashboard → Vaults)\r\nAn API key must be generated in the Dashboard (Dashboard → Developers → API Keys → Create New)\r\nYour API Key, API Secret, and Passphrase saved securely\r\n\r\n\r\n## How the Platform is Structured\r\nVaultody organises your assets across three levels. Understanding this hierarchy is essential before making any API call:\r\nVault (your company's root container — created in the Dashboard)\r\n\r\n └── Vault Account (one per user or entity — created via API)\r\n\r\n └── Address (one per blockchain — generated via API)\r\n\r\n └── Asset balances (ETH, BTC, USDT, etc.)\r\n\r\nVault — top-level container. You get a vaultId from the Dashboard or GET /vaults/{networkType}.\r\nVault Account — a logical wallet for one user or entity. Created with POST /vaults/{vaultId}/vault-account.\r\nAddress — a blockchain-specific deposit address. Generated with POST /vaults/{vaultId}/{blockchain}/{network}/addresses.\r\n\r\n\r\n## Supported Protocols and Networks\r\nVaultody supports 17 blockchain protocols including Ethereum, Bitcoin, BNB Smart Chain, Tron, Solana, Polygon, Avalanche, XRP, and more — on both mainnet and testnet.\r\nFor the full list of supported blockchains and the exact blockchain / network string values to use in API calls, see the Supported Blockchains & Networks guide.\r\n\r\n## The Dashboard\r\nThe Vaultody Dashboard is your control panel for account-level operations that complement the API. From the Dashboard you can:\r\n\r\nCreate and manage Vaults\r\nSet approval policies for outgoing transactions\r\nView balances and transaction history\r\nCreate and manage transactions \r\nGenerate and manage API keys with scoped permissions\r\nConfigure and verify webhook endpoints\r\nManage team members and their access levels\r\nAccess the Vaultody mobile app for transaction approvals\r\n\r\n\r\nNote: Vaults are created in the Dashboard, not via the API. Before making your first API call you need at least one Vault created and your vaultId ready.\r\n\r\n\r\n### Quick Start: Your First 5 API Calls\r\nHere is the minimal sequence to get a deposit address working end to end.\r\n\r\n#### Step 1 — Get your Vault ID\r\n\r\n`httpGET /vaults/test`\r\n\r\nFind the id field in the first item — this is your vaultId.\r\n\r\n```\r\n{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"id\": \"66d866bd469e1d00079d91d5\",\r\n \"name\": \"My Test Vault\",\r\n \"type\": \"test\"\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n#### Step 2 — Create a Vault Account\r\n\r\nhttpPOST /vaults/{vaultId}/vault-account\r\n\r\n```\r\n{\r\n \"data\": {\r\n \"item\": {\r\n \"name\": \"User Alice\",\r\n \"color\": \"#00C7E6\",\r\n \"isHiddenInDashboard\": false\r\n }\r\n }\r\n}\r\n```\r\n\r\nSave the vaultAccountId from the response.\r\n\r\n#### Step 3 — Generate a Deposit Address\r\n\r\nhttpPOST /vaults/{vaultId}/ethereum/sepolia/addresses\r\n\r\n```\r\n{\r\n \"data\": {\r\n \"item\": {\r\n \"label\": \"Alice deposit\",\r\n \"vaultAccountId\": \"68dfaeae39a4b80007c4f707\"\r\n }\r\n }\r\n}\r\n```\r\n\r\nThe address in the response is what you share with your user to receive funds.\r\n\r\n\r\n#### Step 4 — Get Supported Assets\r\nFind the assetId for the asset you want to send:\r\nhttpGET /supported-assets?assetUnit=ETH&blockchain=ethereum&networkType=test\r\nThen initiate the transfer:\r\nhttpPOST /vaults/{vaultId}/transaction-requests/single-transfer\r\n```\r\njson{\r\n \"data\": {\r\n \"item\": {\r\n \"vaultAccountId\": \"68dfaeae39a4b80007c4f707\",\r\n \"assetId\": \"6523e058a06ebf1322d7dd6f\",\r\n \"fromAddress\": \"0xa5bd60af2ed1499ce8292bb2e6c0179dcea34f33\",\r\n \"toAddress\": \"0xbfe14b26d2680a232499f059d251f2486f32cdff\",\r\n \"amount\": \"0.01\",\r\n \"feePriority\": \"standard\",\r\n \"note\": \"Test withdrawal\"\r\n }\r\n }\r\n}\r\n```\r\n#### Step 5 — Listen for Events\r\n\r\nSet up a webhook endpoint in the Dashboard and subscribe to events like INCOMING_CONFIRMED_COIN_TX and OUTGOING_MINED to receive real-time notifications.\r\n\r\n### Authenticate Requests\r\n\r\nEvery API request must be signed using HMAC-SHA256. The signature is generated from your API Secret, timestamp, HTTP method, path, and request body.\r\nYou need to include four headers on every call:\r\nHeaderValuex-api-keyYour public API keyx-api-signBase64-encoded HMAC-SHA256 signaturex-api-timestampCurrent UNIX timestamp in secondsx-api-passphraseYour passphrase\r\nFor the complete signing process with code examples in Python, Node.js, and Postman, see Vaultody API Authentication.\r\n\r\nTest vs. Production\r\nUse a test vault (type: test) during development — it connects to blockchain testnets and uses funds with no real monetary value.\r\nSwitch to a main vault (type: main) when going to production. Mainnet access requires a paid subscription plan.\r\nDevelopment: GET /vaults/test → use testnet networks (sepolia, nile, testnet...)\r\nProduction: GET /vaults/main → use mainnet networks (mainnet...)\r\n\r\nWhat's Next\r\n\r\nVaultody API Authentication — Complete signing guide with code examples\r\nPlatform Architecture — Deep dive into vaults, accounts, addresses, and the MPC model\r\nVault Account Hierarchy — How to structure wallets for your users\r\nReceiving Funds — Step-by-step deposit integration guide\r\nSending Funds — Withdrawals, fee estimation, and transfer types\r\nWebhooks — Real-time event notifications and signature verification\r\n\r\n\r\nNeed Help?\r\nIf you need additional assistance, visit the Vaultody Help Center for FAQs, guides, and direct support, or email us at support@vaultody.com." }, { "name": "Vaultody API Authentication", "description": "Vaultody REST API uses HMAC-SHA256 (Hash-based Message Authentication Code) to authenticate and authorize every request. You must sign each API call to verify your identity and ensure requests have not been tampered with in transit.\r\n\r\n## Overview\r\nTo interact with the Vaultody API securely, you need to:\r\n\r\nGenerate an API key pair (Key, Secret, Passphrase) in the Dashboard.\r\nSign each request using the HMAC-SHA256 algorithm.\r\nInclude four required headers with every request.\r\n\r\n\r\n## Required Credentials\r\nGenerate your credentials in the Dashboard under Developers → API Keys → Create New API Key.\r\n\r\nAPI Key (x-api-key) — the public identifier of your application. Safe to log.\r\nAPI Secret — used to compute the signature. Never share or expose this value.\r\nPassphrase (x-api-passphrase) — an additional user-defined secret for added security.\r\n\r\n\r\nSecurity: Store your API Secret and Passphrase in environment variables or a secrets manager. Never commit them to source code or include them in client-side applications.\r\n\r\n\r\n### Signature Generation\r\nThe x-api-sign header is generated by signing a message string with your API Secret using HMAC-SHA256.\r\nStep 1 — Build the message string\r\nConcatenate these five elements in order with no separator:\r\n\r\n`{timestamp}{HTTP_METHOD}{request_path}{body}{query_params}`\r\n\r\nRules:\r\n\r\n`timestamp` — current UNIX timestamp in seconds (integer as string)\r\n`HTTP_METHOD` — uppercase: `GET`, `POST`, `PUT`\r\n`request_path` — the URL path only, starting with `/` (e.g. `/vaults/main`)\r\n`body` — the raw JSON request body string. Use {} for GET requests and requests with no body\r\nquery_params — query parameters as a JSON object string. Use {} if none\r\n\r\nExamples:\r\nGET `/vaults/main` with no body and no query params:\r\n`1715709672GET/vaults/main{}{}`\r\n\r\nPOST` /vaults/{vaultId}/vault-account` with body:\r\n```\r\n{\r\n \"context\": \"yourExampleString\",\r\n \"data\": {\r\n \"item\": {\r\n \"color\": \"#00C7E6\",\r\n \"isHiddenInDashboard\": false,\r\n \"name\": \"User Alice\"\r\n }\r\n }\r\n}\r\n```\r\n\r\nImportant: The JSON body must be minified (no extra whitespace or newlines) before signing. Whitespace differences will cause signature mismatch.\r\n\r\nStep 2 — Decode the API Secret\r\nYour API Secret is Base64-encoded. Decode it to raw bytes before signing:\r\npythondecoded_secret = base64.b64decode(api_secret)\r\nStep 3 — Compute the HMAC-SHA256 signature\r\npythonsignature = hmac.new(decoded_secret, message.encode('utf-8'), hashlib.sha256).digest()\r\nStep 4 — Base64-encode the signature\r\npythonsignature_b64 = base64.b64encode(signature).decode()\r\nThis final value is your x-api-sign header.\r\n\r\n### Required Headers\r\nInclude all four headers on every request:\r\nHeaderDescriptionx-api-keyYour public API keyx-api-signBase64-encoded HMAC-SHA256 signaturex-api-timestampCurrent UNIX timestamp in secondsx-api-passphraseYour passphraseContent-TypeMust be application/json on all requests\r\n\r\nCode Examples\r\n```\r\nPython\r\npythonimport time, hmac, hashlib, base64, requests, json\r\n\r\napi_key = 'your_api_key'\r\napi_secret = 'your_api_secret'\r\npassphrase = 'your_passphrase'\r\n\r\ndef signed_request(method, path, body=None, params=None):\r\n timestamp = str(int(time.time()))\r\n body_str = json.dumps(body, separators=(',', ':')) if body else '{}'\r\n query_str = json.dumps(params, separators=(',', ':')) if params else '{}'\r\n message = timestamp + method.upper() + path + body_str + query_str\r\n\r\n decoded_secret = base64.b64decode(api_secret)\r\n signature = hmac.new(decoded_secret, message.encode('utf-8'), hashlib.sha256).digest()\r\n signature_b64 = base64.b64encode(signature).decode()\r\n\r\n headers = {\r\n 'x-api-key': api_key,\r\n 'x-api-sign': signature_b64,\r\n 'x-api-timestamp': timestamp,\r\n 'x-api-passphrase': passphrase,\r\n 'Content-Type': 'application/json'\r\n }\r\n\r\n url = 'https://rest.vaultody.com' + path\r\n if method.upper() == 'GET':\r\n return requests.get(url, headers=headers, params=params)\r\n elif method.upper() == 'POST':\r\n return requests.post(url, headers=headers, json=body)\r\n elif method.upper() == 'PUT':\r\n return requests.put(url, headers=headers, json=body)\r\nExample: list vaults\r\nresponse = signed_request('GET', '/vaults/main')\r\nprint(response.json())\r\n```\r\n\r\nNode.js\r\n\r\n```\r\njavascriptconst crypto = require('crypto');\r\nconst axios = require('axios');\r\n\r\nconst apiKey = 'your_api_key';\r\nconst apiSecret = 'your_api_secret';\r\nconst passphrase = 'your_passphrase';\r\n\r\nfunction signedRequest(method, path, body = null, params = null) {\r\n const timestamp = Math.floor(Date.now() / 1000).toString();\r\n const bodyStr = body ? JSON.stringify(body) : '{}';\r\n const queryStr = params ? JSON.stringify(params) : '{}';\r\n const message = timestamp + method.toUpperCase() + path + bodyStr + queryStr;\r\n\r\n const hmac = crypto.createHmac('sha256', Buffer.from(apiSecret, 'base64'));\r\n hmac.update(message);\r\n const signature = hmac.digest('base64');\r\n\r\n const headers = {\r\n 'x-api-key': apiKey,\r\n 'x-api-sign': signature,\r\n 'x-api-timestamp': timestamp,\r\n 'x-api-passphrase': passphrase,\r\n 'Content-Type': 'application/json',\r\n };\r\n\r\n const url = 'https://rest.vaultody.com' + path;\r\n const config = { headers, params };\r\n\r\n if (method.toUpperCase() === 'GET') return axios.get(url, config);\r\n if (method.toUpperCase() === 'POST') return axios.post(url, body, { headers });\r\n if (method.toUpperCase() === 'PUT') return axios.put(url, body, { headers });\r\n}\r\n\r\n// Example: list vaults\r\nsignedRequest('GET', '/vaults/main')\r\n .then(res => console.log(res.data))\r\n .catch(err => console.error(err.response.data));\r\n```\r\nPHP\r\n\r\n```\r\nphp {\r\n acc[item.key] = item.value;\r\n return acc;\r\n}, {});\r\n\r\nvar messageToSign = timestamp + pm.request.method.toUpperCase()\r\n + pm.request.url.getPath()\r\n + bodyStr\r\n + JSON.stringify(queryObj);\r\n\r\nvar key = CryptoJS.enc.Base64.parse(secret);\r\nvar signature = CryptoJS.enc.Base64.stringify(CryptoJS.HmacSHA256(messageToSign, key));\r\n\r\npm.request.headers.add({ key: \"x-api-timestamp\", value: timestamp });\r\npm.request.headers.add({ key: \"x-api-sign\", value: signature });\r\npm.request.headers.add({ key: \"x-api-key\", value: secretKey.toString() });\r\npm.request.headers.add({ key: \"x-api-passphrase\", value: passphrase });\r\npm.request.headers.add({ key: \"Content-Type\", value: \"application/json\" });\r\n```\r\n\r\n### Security Best Practices\r\n\r\nNever expose your API Secret — treat it like a password. Store it in environment variables.\r\nUse IP whitelisting — restrict API key access to known server IP addresses in the Dashboard.\r\nRotate keys regularly — regenerate API keys periodically and immediately if you suspect a compromise.\r\nScope your keys — create separate API keys with minimal required permissions for each service.\r\nGenerate a fresh timestamp per request — never reuse or cache a timestamp across calls.\r\n\r\n\r\n### Troubleshooting\r\n\r\n\r\n| HTTP Code | Error Message | Cause | Fix |\r\n| -------- | -------- | -------- | |\r\n|401 | `missing_api_key` | `x-api-key` header not sent | Add all four auth headers to every request | \r\n|401 | `invalid_api_key` | Wrong, expired, or deleted API key | Regenerate a new key in the Dashboard | \r\n|401 | `invalid_api_key` | Signature mismatch | Check timestamp freshness, body minification, and secret decoding | \r\n|403| `endpoint_not_allowed_for_api_key` | Key lacks permission for this endpoint | Create a key with the correct scopes | \r\n|403 | `endpoint_not_allowed_for_api_key` | Key lacks permission for this endpoint | Upgrade your plan | \r\n|400 | `invalid_request_body_structure` | Body not wrapped in `{ data: { item: {} } }` | Wrap all POST/PUT bodies correctly | \r\n|415 | `unsupported_media_type` |Missing `Content-Type: application/json` | Add the Content-Type header | \r\n\r\n\r\nCommon Signature Failure Causes\r\nTimestamp drift — the most frequent cause of 401 errors. Your server clock must be within ~30 seconds of Vaultody's server time. Always call `time() / Date.now()` inside your signing function, never outside it.\r\nBody whitespace — extra spaces or newlines in the JSON body will produce a different signature than the server expects. Minify your body string before signing (use separators=(`',', ':'`) in Python, `JSON.stringify` in JS).\r\nWrong query format — query parameters must be serialised as a JSON object string (`{\"key\":\"value\"}`), not a URL query string (`key=value`). If there are no query parameters, use `{}`." }, { "name": "Data Flow Limiting", "description": "## Data Flow Limiting\r\n### Overview\r\nVaultody applies two types of limits to API usage: rate limits (how many requests you can make per time window) and pagination limits (how many items are returned per API response). Both are determined by your subscription plan.\r\n\r\n### Rate Limiting\r\nEach API is subject to a request rate limit. When you exceed the limit, the API returns:\r\n`httpHTTP 429 Too Many Requests`\r\n```\r\n\r\n{\r\n \"error\": {\r\n \"code\": \"request_limit_reached\",\r\n \"message\": \"The request limit has been reached. Please contact our team or upgrade your plan.\"\r\n }\r\n}\r\n```\r\n\r\nHandling 429 Responses\r\n\r\nWhen you receive a 429, back off and retry with increasing delays. Do not retry immediately — this will continue to be rate-limited.\r\n\r\nPython — exponential backoff:\r\n```\r\npython\r\nimport time\r\n\r\ndef request_with_retry(method, path, body=None, max_retries=4):\r\n for attempt in range(max_retries):\r\n response = signed_request(method, path, body)\r\n if response.status_code == 429:\r\n wait_seconds = 2 ** attempt # 1s → 2s → 4s → 8s\r\n print(f\"Rate limited. Retrying in {wait_seconds}s...\")\r\n time.sleep(wait_seconds)\r\n continue\r\n return response\r\n raise Exception(\"Max retries exceeded after rate limiting\")\r\nNode.js — exponential backoff:\r\njavascriptasync function requestWithRetry(method, path, body = null, maxRetries = 4) {\r\n for (let attempt = 0; attempt < maxRetries; attempt++) {\r\n const response = await signedRequest(method, path, body);\r\n if (response.status === 429) {\r\n const wait = Math.pow(2, attempt) * 1000; // 1s, 2s, 4s, 8s\r\n console.log(`Rate limited. Retrying in ${wait / 1000}s...`);\r\n await new Promise(r => setTimeout(r, wait));\r\n continue;\r\n }\r\n return response;\r\n }\r\n throw new Error('Max retries exceeded after rate limiting');\r\n}\r\n```\r\n\r\nBest practice: Spread your API calls over time where possible. If you are syncing large amounts of data, use pagination and process pages sequentially rather than in parallel.\r\n\r\n\r\n### Pagination\r\nVaultody uses cursor-based pagination for all list endpoints. This means pages are navigated using the ID of the last item you received, not a page number. This approach is consistent and reliable even when new records are added between requests.\r\nPagination Parameters\r\n\r\nPagination Parameters\r\n\r\n| Parameter | Type | Default | Description | \r\n| -------- | -------- | -------- |\r\n| limit | integer | 50 | Number of items to return per page. Maximum: 50 |\r\n| startingAfter | string | — | The id (or equivalent ID field) of the last item from the previous page. Omit for the first page. |\r\n\r\n\r\n### How It Works\r\nOn the first request, omit startingAfter:\r\n`httpGET /vaults/{vaultId}/vault-accounts/details?limit=50`\r\n\r\nThe response includes a hasMore field:\r\n\r\n```\r\n{\r\n \"apiVersion\": \"2026-03-20\",\r\n \"requestId\": \"601c1710034ed6d407996b30\",\r\n \"data\": {\r\n \"limit\": 50,\r\n \"hasMore\": true,\r\n \"items\": [\r\n {\r\n \"vaultAccountId\": \"68dfaeae39a4b80007c4f707\",\r\n \"vaultAccountName\": \"User Alice\",\r\n ...\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n\r\nIf `hasMore` is `true`, take the `vaultAccountId` (or the relevant ID field) of the last item in the array and pass it as `startingAfter` on the next request:\r\n\r\n`httpGET /vaults/{vaultId}/vault-accounts/details?limit=50&startingAfter=68dfaeae39a4b80007c4f707`\r\n\r\nRepeat until hasMore is false.\r\n\r\n### Full Pagination Example\r\nPython — fetch all Vault Accounts:\r\n```\r\npythondef get_all_vault_accounts(vault_id):\r\n all_accounts = []\r\n starting_after = None\r\n\r\n while True:\r\n params = {'limit': 50}\r\n if starting_after:\r\n params['startingAfter'] = starting_after\r\n\r\n resp = signed_request('GET', f'/vaults/{vault_id}/vault-accounts/details', params=params)\r\n data = resp.json()['data']\r\n\r\n all_accounts.extend(data['items'])\r\n\r\n if not data['hasMore']:\r\n break\r\n```\r\n\r\n # Use the last item's ID as the next cursor\r\n starting_after = data['items'][-1]['vaultAccountId']\r\n\r\n return all_accounts\r\nNode.js — fetch all Vault Accounts:\r\n```\r\n\r\njavascriptasync function getAllVaultAccounts(vaultId) {\r\n const allAccounts = [];\r\n let startingAfter = null;\r\n\r\n do {\r\n const params = { limit: 50 };\r\n if (startingAfter) params.startingAfter = startingAfter;\r\n\r\n const resp = await signedRequest('GET', `/vaults/${vaultId}/vault-accounts/details`, null, params);\r\n const { items, hasMore } = resp.data.data;\r\n\r\n allAccounts.push(...items);\r\n startingAfter = hasMore ? items[items.length - 1].vaultAccountId : null;\r\n\r\n } while (startingAfter !== null);\r\n\r\n return allAccounts;\r\n}\r\n```\r\n\r\nSubscription Tiers\r\nAPI data flow limits and feature availability are determined by your subscription tier. Higher tiers provide increased rate limits, higher Vault Account caps.\r\n\r\nFor details on what is included in each plan, please contact us or visit the Vaultody [pricing page.](http://vaultody.com/pricing)\r\n\r\nMainnet access is not available on free plans. If you receive a feature_mainnets_not_allowed_for_plan error, your current plan is restricted to testnet. Upgrade your plan to enable mainnet access." }, { "name": "Standards and Conventions", "description": "Vaultody adheres to the OpenAPI 3.0 standard and RESTful design principles. This page documents the conventions you will encounter throughout the API so you can integrate confidently and predictably.\r\n\r\n### Base URL\r\nAll REST API requests are made to:\r\n\r\n`https://rest.vaultody.com`\r\n\r\nHTTPS is required for all requests. HTTP is not supported. The maximum URI length is 2000 characters including path and query string.\r\n\r\n### URI Structure & Naming\r\n\r\n* Paths use lowercase letters and spinal-case: /vault-accounts/details\r\n* Path parameters use camelCase: {vaultId}, {vaultAccountId}, {blockchain}\r\n* Query parameters use camelCase: ?startingAfter=...&isHideEmpty=true\r\n* All endpoints are prefixed by resource category: /vaults/, /supported-assets, /info/\r\n\r\n\r\n## HTTP Methods\r\n\r\n\r\n\r\n\r\n| Method | Usage | \r\n| -------- | -------- \r\n| GET | Retrieve a resource or list of resources. No request body. |\r\n| POST | Create a new resource or trigger an action. |\r\n| PUT | Update an existing resource. |\r\n\r\n\r\n#### Request Requirements\r\n\r\n* All requests must include Content-Type: application/json\r\n* All requests must include the four authentication headers (x-api-key, x-api-sign, x-api-timestamp, x-api-passphrase) — see Vaultody API Authentication\r\n* POST and PUT request bodies must follow the envelope structure: { \"data\": { \"item\": { ...fields } } }\r\n* Request bodies must be valid JSON\r\n\r\n##### Request Body Envelope\r\nEvery POST and PUT request body must be wrapped in a data.item envelope:\r\n```\r\n{\r\n \"data\": {\r\n \"item\": {\r\n \"name\": \"My Vault Account\",\r\n \"color\": \"#00C7E6\",\r\n \"isHiddenInDashboard\": false\r\n }\r\n }\r\n}\r\n```\r\nOmitting this wrapper will result in a 422 invalid_request_body_structure error.\r\nAn optional context string can be included at the top level of any request body or as a query parameter. It is returned unchanged in the response and can be used to correlate responses with requests in batch or async workflows:\r\n\r\n```\r\n{\r\n \"context\": \"user-onboarding-flow-step-3\",\r\n \"data\": {\r\n \"item\": { ... }\r\n }\r\n}\r\n```\r\n\r\n##### Response Envelope\r\nEvery response — success or error — follows a consistent envelope:\r\n\r\n```\r\n{\r\n \"apiVersion\": \"2026-03-20\",\r\n \"requestId\": \"601c1710034ed6d407996b30\",\r\n \"context\": \"user-onboarding-flow-step-3\",\r\n \"data\": {\r\n \"item\": { ... }\r\n }\r\n}\r\n```\r\n\r\n| Field | Description | \r\n| -------- | -------- \r\n| apiVersion | The version of the API that handled this request. |\r\n| requestId | Unique identifier for this specific request, generated by Vaultody. Include in support tickets. |\r\n| context | Echoed back from your request if you provided one. |\r\n| data | Contains `item` (single resource) or `items` + pagination fields (list) |\r\n\r\n```\r\n{\r\n \"apiVersion\": \"2026-03-20\",\r\n \"requestId\": \"601c1710034ed6d407996b30\",\r\n \"data\": {\r\n \"limit\": 50,\r\n \"startingAfter\": \"5ca21f92cf5431000105d1a7\",\r\n \"hasMore\": true,\r\n \"items\": [ ... ]\r\n }\r\n}\r\n```\r\nError response envelope:\r\n```\r\n{\r\n \"apiVersion\": \"2026-03-20\",\r\n \"requestId\": \"601c1710034ed6d407996b30\",\r\n \"error\": {\r\n \"code\": \"resource_not_found\",\r\n \"message\": \"The specified resource has not been found.\",\r\n \"details\": [\r\n {\r\n \"attribute\": \"vaultAccountId\",\r\n \"message\": \"No vault account found with the provided ID\"\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\nData Types & Field Conventions\r\n\r\n| Convention | Example | \r\n| -------- | -------- |\r\n| Amounts are strings, not numbers | \"amount\": \"0.001\" not \"amount\": 0.001 |\r\n| Booleans are native JSON booleans | \"isHiddenInDashboard\": false |\r\n| Timestamps are UNIX integers in seconds | \"createdAt\": 1760621154 |\r\n| IDs are hex strings | \"vaultAccountId\": \"68dfaeae39a4b80007c4f707\" |\r\n| Colors are hex color codes | \"color\": \"#00C7E6\" |\r\n\r\nHTTP Status Codes\r\n\r\n| Status | Meaning | \r\n| -------- | -------- |\r\n| 200 OK | Request succeeded (GET, PUT) |\r\n| 201 Created | Resource successfully created (POST) |\r\n| 400 Bad Request | Malformed request — invalid path parameter, pagination error, or bad blockchain/network value |\r\n| 401 Unauthorized | Authentication failed — missing or invalid API key or signature |\r\n| 403 Forbidden |Valid credentials but insufficient permissions, plan restriction, or business rule violation |\r\n| 404 Not Found | The requested resource ID does not exist |\r\n| 409 Conflict | Data validation failure, insufficient balance, or state conflict |\r\n| 415 Unsupported Media Type | Content-Type header is missing or not application/json |\r\n| 422 Unprocessable Entity | Request body does not follow the { data: { item: {} } } envelope structure |\r\n| 429 Too Many Requests | Rate limit exceeded |\r\n| 500 Internal Server Error | Unexpected server-side error |\r\n\r\n\r\n### API Versioning\r\nVaultody uses date-based versioning. The current version is `2026-03-20.`\r\nEvery response includes the version that handled the request:\r\n`{ \"apiVersion\": \"2026-03-20\" }`\r\n\r\n#### How versioning works\r\n\r\n* New versions are released when breaking changes are introduced\r\n* Each version is identified by its release date (e.g. 2026-03-20)\r\n* You can pin your API key to a specific version in the Dashboard under Developers → API Keys\r\n* Non-breaking changes (new optional fields, new endpoints) are added to the current version without a version bump\r\n\r\n#### What constitutes a breaking change\r\n\r\n* Removing or renaming a field\r\n* Changing a field's data type\r\n* Changing required fields\r\n* Changing the meaning of an existing status code or error code\r\n\r\nNew optional fields, new endpoints, and new error codes are not considered breaking changes." }, { "name": "Vaults", "description": "This category displays Vaults endpoints which can be used to interact with Vault in your account" }, { "name": "Transactions", "description": "This category displays endpoints which can be used to create transactions." }, { "name": "Addresses", "description": "This category displays endpoints which can be used to obtain information for the addresses." }, { "name": "Webhooks", "description": "## Webhooks\r\nWebhooks (also called callbacks) are HTTP POST requests that Vaultody sends to your server when a subscribed event occurs. They allow your application to react to blockchain activity and transaction status changes in real time, without polling the API.\r\n\r\n### Setting Up Webhooks\r\n\r\n1. In the Dashboard, go to Developers → Webhooks\r\n2. Click Add Endpoint and enter your publicly accessible callback URL\r\n3. Set a Signing Secret — your own secret string used to verify incoming requests\r\n4. Select the events you want to subscribe to\r\n5. Save the webhook\r\n\r\nYour callback URL must be publicly accessible over HTTPS. Local development URLs (e.g. localhost) will not receive webhooks. Use a tool like ngrok to expose a local server during development.\r\n\r\n\r\nVerifying the Signature\r\nEvery webhook request includes an x-signature header. Always verify this signature before processing the event — it proves the request genuinely came from Vaultody and has not been tampered with.\r\nVaultody computes the signature by running HMAC-SHA256 over the raw request body using your Signing Secret, then Base64-encoding the result.\r\n### Python (Flask)\r\n```\r\npython\r\nimport hmac, hashlib, base64\r\nfrom flask import Flask, request, abort\r\n\r\napp = Flask(__name__)\r\nSIGNING_SECRET = \"your_signing_secret\"\r\n\r\n@app.route(\"/webhook\", methods=[\"POST\"])\r\ndef handle_webhook():\r\n signature = request.headers.get(\"x-signature\", \"\")\r\n raw_body = request.get_data() # raw bytes — do not parse first\r\n\r\n expected = base64.b64encode(\r\n hmac.new(SIGNING_SECRET.encode(\"utf-8\"), raw_body, hashlib.sha256).digest()\r\n ).decode()\r\n\r\n if not hmac.compare_digest(expected, signature):\r\n abort(401)\r\n\r\n payload = request.get_json()\r\n process_event(payload[\"data\"][\"event\"], payload[\"data\"][\"item\"])\r\n return \"\", 200\r\n```\r\n### Node.js (Express)\r\n```\r\njavascript\r\nconst express = require(\"express\");\r\nconst crypto = require(\"crypto\");\r\n\r\nconst app = express();\r\nconst SIGNING_SECRET = \"your_signing_secret\";\r\n\r\n// Use express.raw() to preserve the raw body for signature verification\r\napp.post(\"/webhook\", express.raw({ type: \"application/json\" }), (req, res) => {\r\n const signature = req.headers[\"x-signature\"] || \"\";\r\n const expected = crypto\r\n .createHmac(\"sha256\", SIGNING_SECRET)\r\n .update(req.body)\r\n .digest(\"base64\");\r\n\r\n if (!crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature))) {\r\n return res.status(401).send(\"Invalid signature\");\r\n }\r\n\r\n // Respond 200 immediately, then process asynchronously\r\n res.status(200).end();\r\n\r\n const payload = JSON.parse(req.body.toString());\r\n processEvent(payload.data.event, payload.data.item);\r\n});\r\n```\r\n### PHP\r\n```\r\nphp\r\n {\r\n if (!isValidSignature(req)) return res.status(401).end();\r\n\r\n res.status(200).end(); // ← acknowledge immediately\r\n\r\n setImmediate(() => { // ← process asynchronously\r\n const payload = JSON.parse(req.body.toString());\r\n handleEvent(payload);\r\n });\r\n});\r\n\r\n```\r\n### Event Reference\r\n\r\n##### Outgoing Transaction Events\r\n\r\n| Event | When it fires| \r\n| -------- | -------- | \r\n| TRANSACTION_REQUEST | A new outgoing transaction request has been created and is awaiting approval |\r\n| TRANSACTION_APPROVED | The required number of approvals has been reached |\r\n| TRANSACTION_REJECTED | An approver rejected the transaction |\r\n| TRANSACTION_BROADCASTED | The transaction has been submitted to the blockchain mempool |\r\n| OUTGOING_MINED | The transaction has been confirmed on-chain successfully |\r\n| OUTGOING_FAILED | The transaction failed before or after broadcast |\r\n\r\n##### Incoming Transaction Events\r\n\r\n| Event | When it fires| \r\n| -------- | -------- | \r\n| INCOMING_MINED_TX | An incoming transaction first appears in a block (not yet final) |\r\n| INCOMING_CONFIRMED_COIN_TX | An incoming native coin deposit (ETH, BTC, TRX, etc.) reached required confirmations |\r\n| INCOMING_CONFIRMED_TOKEN_TX | An incoming token deposit (USDT, USDC, etc.) reached required confirmations |\r\n| INCOMING_CONFIRMED_INTERNAL_TX | An internal EVM transaction (smart contract triggered) reached required confirmations |\r\n\r\n\r\nExample Payloads\r\n###### TRANSACTION_REQUEST\r\n```\r\n\r\njson\r\n\r\n{\r\n \"walletId\": \"685121237d7d1e0007ac1a1d\",\r\n \"webhookId\": \"68516e9c6620b0a4790ed541\",\r\n \"idempotencyKey\": \"928fe178...d371dda9\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"TRANSACTION_REQUEST\",\r\n \"item\": {\r\n \"vaultAccountId\": \"69ba58c529eb49000746b311\",\r\n \"assetId\": \"6913471c6b2794841dc8fb6f\",\r\n \"unit\": \"ETH\",\r\n \"requestId\": \"686cd2860ca2f4fd25f77099\",\r\n \"transactionType\": \"COIN\"\r\n }\r\n }\r\n}\r\n```\r\n\r\n###### TRANSACTION_APPROVED\r\n```\r\njson\r\n\r\n{\r\n \"data\": {\r\n \"event\": \"TRANSACTION_APPROVED\",\r\n \"item\": {\r\n \"requestId\": \"686cd2860ca2f4fd25f77099\",\r\n \"unit\": \"ETH\",\r\n \"requiredApprovals\": 2,\r\n \"currentApprovals\": 2,\r\n \"requiredRejections\": 1,\r\n \"currentRejections\": 0,\r\n \"transactionType\": \"COIN\"\r\n }\r\n }\r\n}\r\n```\r\n\r\n###### TRANSACTION_REJECTED\r\n```\r\njson\r\n{``\r\n \"data\": {\r\n \"event\": \"TRANSACTION_REJECTED\",\r\n \"item\": {\r\n \"requestId\": \"686cd2860ca2f4fd25f77099\",\r\n \"requiredApprovals\": 2,\r\n \"currentApprovals\": 0,\r\n \"requiredRejections\": 1,\r\n \"currentRejections\": 1\r\n }\r\n }\r\n}\r\n```\r\n\r\n\r\n###### OUTGOING_MINED\r\n```\r\njson\r\n{\r\n \"data\": {\r\n \"event\": \"OUTGOING_MINED\",\r\n \"item\": {\r\n \"requestId\": \"686cd2860ca2f4fd25f77099\",\r\n \"transactionId\": \"0x37c2e069...efb50623\",\r\n \"unit\": \"ETH\",\r\n \"currentApprovals\": 2,\r\n \"currentRejections\": 0\r\n }\r\n }\r\n}\r\n```\r\n###### OUTGOING_FAILED\r\n```\r\njson\r\n{\r\n \"data\": {\r\n \"event\": \"OUTGOING_FAILED\",\r\n \"item\": {\r\n \"requestId\": \"686cd2860ca2f4fd25f77099\",\r\n \"failedReason\": \"INSUFFICIENT_FUNDS\",\r\n \"currentApprovals\": 1,\r\n \"currentRejections\": 0\r\n }\r\n }\r\n}\r\n```\r\n###### INCOMING_CONFIRMED_COIN_TX\r\n```\r\njson\r\n{\r\n \"data\": {\r\n \"event\": \"INCOMING_CONFIRMED_COIN_TX\",\r\n \"item\": {\r\n \"vaultAccountId\": \"69ba58c529eb49000746b311\",\r\n \"assetId\": \"6913471c6b2794841dc8fb6f\",\r\n \"address\": \"tb1q3ft8aq4daesecw8yfz0gt4hgursm0l6nhj06m9\",\r\n \"amount\": \"0.005\",\r\n \"unit\": \"BTC\",\r\n \"transactionId\": \"cf0d9a82045c13dba627788d9508b3dfd761e46b49deba48d004c82e2f2f83f2\",\r\n \"currentConfirmations\": 6,\r\n \"targetConfirmations\": 6,\r\n \"status\": \"success\",\r\n \"minedInBlock\": {\r\n \"height\": 4547001,\r\n \"hash\": \"0000000000000004a25a24749cbca4ac6b2d62b9932f0fefbb9cb8a7a9e5619e\",\r\n \"timestamp\": 1750837928\r\n }\r\n }\r\n }\r\n}\r\n```\r\n###### INCOMING_CONFIRMED_TOKEN_TX\r\n```\r\njson\r\n{\r\n \"data\": {\r\n \"event\": \"INCOMING_CONFIRMED_TOKEN_TX\",\r\n \"item\": {\r\n \"address\": \"TDGFc6pDe5q2gc9zi4p2JQHfJTXVTBw7yu\",\r\n \"tokenType\": \"TRC-20\",\r\n \"transactionId\": \"a6f8225d5a905fc236e5d85d88f77d127d48e80bb456042853c8ed6210182f4f\",\r\n \"currentConfirmations\": 12,\r\n \"targetConfirmations\": 12,\r\n \"status\": \"success\",\r\n \"token\": {\r\n \"tokenName\": \"Tether USD\",\r\n \"tokenSymbol\": \"USDT\",\r\n \"decimals\": 6,\r\n \"tokensAmount\": \"100.0\",\r\n \"contract\": \"TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj\"\r\n }\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Customer's Signing Secret\r\nThe Signing Secret is set by you when creating the webhook subscription. It is used to generate the `x-signature` header sent by Vaultody on every callback.\r\n\r\n* The Signing Secret is per subscription, not per callback\r\n* You can use the same secret for all subscriptions or different ones for each\r\n* If your Signing Secret is compromised, rotate it immediately in the Dashboard" }, { "name": "Transactions Fee", "description": "" }, { "name": "Help Center", "description": "Welcome to the Vaultody Help Center — a centralized resource designed to assist you in effectively using Vaultody's API and platform. Whether you're a developer starting your integration, an enterprise user managing digital assets, or troubleshooting a specific issue, you'll find the right resources here.\r\n\r\n### Knowledge Base\r\nOur Knowledge Base covers everything from initial setup to advanced platform features:\r\n\r\n* Getting Started — Introduction to Vaultody, account setup, API key generation, and your first integration\r\n* API Usage — Comprehensive documentation on authenticating, calling endpoints, pagination, and error handling\r\n* Vault Management — Creating and managing Vaults, Vault Accounts, addresses, and assets\r\n* Transaction Workflows — Sending funds, approval policies, transaction lifecycle, and fee management\r\n* Security & Recovery — MPC key model, vault backup, and the Vaultody Open Source Recovery Tool\r\n* Webhooks & Callbacks — Setting up real-time event notifications and verifying webhook signatures\r\n* Billing & Payments — Subscription plans, billing cycles, payment methods, and plan upgrades\r\n\r\nAccess the full Knowledge Base: [Vaultody Help Center](https://support.vaultody.com/portal/en/home)\r\n\r\n### Community Support\r\nJoin the Vaultody developer community to:\r\n\r\nAsk questions and get answers from Vaultody engineers and fellow developers\r\nShare integration patterns, code snippets, and best practices\r\nStay updated on new features, API changes, and platform announcements\r\n\r\nJoin the community: Vaultody Support Community\r\n\r\n### Announcements\r\nStay informed about the latest platform updates:\r\n\r\nNew Features — Newly released endpoints, blockchain support, and platform capabilities\r\nSystem Updates — Scheduled maintenance windows and infrastructure enhancements\r\nSecurity Alerts — Important security advisories and recommended actions\r\nAPI Version Releases — New API versions, deprecation notices, and migration guides\r\n\r\nView the latest announcements: Vaultody Announcements\r\n\r\n### Contact Support\r\nOur support team is here to help with integration questions, account issues, and anything else you need.\r\n\r\nSubmit a support ticket: Contact Support\r\nEmail: support@vaultody.com\r\n\r\nWhen contacting support about an API issue, please include:\r\n\r\n* The requestId from the error response\r\n* The error.code string\r\n* The HTTP method and full URL you called\r\n* A description of the expected vs. actual behaviour" } ], "paths": { "/vaults/{vaultId}/vault-account": { "post": { "tags": [ "Vault Accounts" ], "operationId": "Create Vault Account", "summary": "Create Vault Account", "description": "This endpoint creates a new Vault Account within a specified Vault. Each new Vault Account is created with a unique identifier and customizable display settings, such as name, color, and dashboard visibility.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "The ID of the vault for which a Vault Account will be created.", "example": "66d866bd469e1d00079d91d5" }, "description": "The ID of the vault for which a Vault Account will be created.", "example": "66d866bd469e1d00079d91d5" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVaultAccountRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVaultAccountR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateVaultAccountE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateVaultAccountE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Vault accounts can only be created for vaults of type DEFAULT.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateVaultAccountE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "Failed to create vault account. A vault account with index {index} already exists.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateVaultAccountE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/vault-accounts/details": { "get": { "tags": [ "Vault Accounts" ], "operationId": "List Vault Accounts", "summary": "List Vault Accounts", "description": "Retrieve all Vault Accounts associated with a specific Vault.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "The ID of the vault.", "example": "68dfaeae39a4b80007c4f707" }, "description": "The ID of the vault.", "example": "68dfaeae39a4b80007c4f707" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "isHidden", "required": false, "schema": { "type": "boolean", "description": "When it is set to true, the endpoint will return only Vault Accounts that are marked as hidden in the dashboard (isHiddenInDashboard = true).", "example": false }, "description": "When it is set to true, the endpoint will return only Vault Accounts that are marked as hidden in the dashboard (isHiddenInDashboard = true).", "example": false }, { "in": "query", "name": "isHideEmpty", "required": false, "schema": { "type": "boolean", "description": "When it is set to true, the response will include only Vault Accounts that have a positive balance.", "example": false }, "description": "When it is set to true, the response will include only Vault Accounts that have a positive balance.", "example": false }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVaultAccountsR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultAccountsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultAccountsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultAccountsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/vault-accounts/{vaultAccountId}/details": { "get": { "tags": [ "Vault Accounts" ], "operationId": "Get Vault Account by ID", "summary": "Get Vault Account by ID", "description": "Retrieve detailed information about a specific Vault Account.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultAccountId", "required": true, "schema": { "type": "string", "description": "The unique id of the Vault Account.", "example": "69382b15411179000710d73e" }, "description": "The unique id of the Vault Account.", "example": "69382b15411179000710d73e" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "The ID of the vault for which a Vault Account is created.", "example": "68dfae9739a4b80007c4f706" }, "description": "The ID of the vault for which a Vault Account is created.", "example": "68dfae9739a4b80007c4f706" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVaultAccountByIDR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetVaultAccountByIDE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetVaultAccountByIDE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "The user is not authorized to access the vault accounts.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetVaultAccountByIDE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/vault-accounts/{vaultAccountId}/edit": { "put": { "tags": [ "Vault Accounts" ], "operationId": "Update Vault Account", "summary": "Update Vault Account", "description": "This endpoint allows you to modify the attributes of an existing Vault Account.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultAccountId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the Vault Account.", "example": "68dfaeae39a4b80007c4f707" }, "description": "Unique identifier of the Vault Account.", "example": "68dfaeae39a4b80007c4f707" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "The ID of the vault for which a Vault Account is created.", "example": "68dfaeae39a4b80007c4f707" }, "description": "The ID of the vault for which a Vault Account is created.", "example": "68dfaeae39a4b80007c4f707" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVaultAccountRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVaultAccountR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UpdateVaultAccountE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UpdateVaultAccountE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "The user is not authorized to access the vault accounts.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UpdateVaultAccountE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/vault-accounts/{vaultAccountId}/list-assets": { "get": { "tags": [ "Vault Accounts" ], "operationId": "List Assets by Vault Account ID", "summary": "List Assets by Vault Account ID", "description": "Through this endpoint customers can obtain information about available assets in their vault accounts, with optional filtering by asset symbol.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultAccountId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the vault account.", "example": "68dfae9739a4b80007c4f706" }, "description": "Unique identifier of the vault account.", "example": "68dfae9739a4b80007c4f706" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the vault.", "example": "68dfae9739a4b80007c4f706" }, "description": "Unique identifier of the vault.", "example": "68dfae9739a4b80007c4f706" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "assetUnit", "required": false, "schema": { "type": "string", "description": "Filters results by asset symbol, e.g ETH, LTC,BCH, BNB, TRX, USDT, USDC.", "example": "BTC" }, "description": "Filters results by asset symbol, e.g ETH, LTC,BCH, BNB, TRX, USDT, USDC.", "example": "BTC" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAssetsByVaultAccountIDR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultAccountIDE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultAccountIDE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultAccountIDE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/supported-assets": { "get": { "tags": [ "Assets & Addresses" ], "operationId": "List Supported Assets", "summary": "List Supported Assets", "description": "Retrieves a list of all assets supported by the platform. This endpoint is intended to help users discover which assets are available to be added to their Vault Accounts. Results can be sorted and paginated to ensure efficient and consistent data retrieval, even for large asset sets.", "x-is-list": false, "parameters": [ { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "assetUnit", "required": false, "schema": { "type": "string", "description": "Filter results by asset unit (e.g., BTC, BNB, USDC, TRX, LINK).", "example": "ETH" }, "description": "Filter results by asset unit (e.g., BTC, BNB, USDC, TRX, LINK).", "example": "ETH" }, { "in": "query", "name": "blockchain", "required": false, "schema": { "type": "string", "description": "Filter results by blockchain the asset is supported on (e.g., bitcoin, ethereum, polygon, tron, solana).", "example": "ethereum" }, "description": "Filter results by blockchain the asset is supported on (e.g., bitcoin, ethereum, polygon, tron, solana).", "example": "ethereum" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "networkType", "required": false, "schema": { "type": "string", "description": "Filter by network type: main or test.", "example": "main" }, "description": "Filter by network type: main or test.", "example": "main" }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSupportedAssetsR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSupportedAssetsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSupportedAssetsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListSupportedAssetsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/vault-accounts/{vaultAccountId}/add-asset": { "put": { "tags": [ "Assets & Addresses" ], "operationId": "Add Asset to Address", "summary": "Add Asset to Address", "description": "This endpoint adds a specific asset to an existing vault account and creates an address for it if one does not already exist, enabling the asset to be tracked, receive balances, and be used in future transactions.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultAccountId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the vault account to which the asset will be added.", "example": "68dfae9739a4b80007c4f706" }, "description": "Unique identifier of the vault account to which the asset will be added.", "example": "68dfae9739a4b80007c4f706" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the vault that owns the vault account.", "example": "68dfae9739a4b80007c4f706" }, "description": "Unique identifier of the vault that owns the vault account.", "example": "68dfae9739a4b80007c4f706" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAssetToAddressRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAssetToAddressR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/AddAssetToAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/AddAssetToAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/AddAssetToAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/{blockchain}/{network}/addresses": { "post": { "tags": [ "Assets & Addresses" ], "operationId": "Generate Deposit Address", "summary": "Generate Deposit Address", "description": "Through this endpoint customers can generate a new Receiving/Deposit Addresses into their Vault Account.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "xrp", "zcash", "binance-smart-chain", "tron", "polygon", "optimism", "avalanche", "solana", "arbitrum", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "devnet", "mordor", "nile", "fuji", "sepolia", "amoy" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Represents the unique ID of the specific Vault.", "example": "60c9d9921c38030006675ff6" }, "description": "Represents the unique ID of the specific Vault.", "example": "60c9d9921c38030006675ff6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateDepositAddressRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateDepositAddressR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GenerateDepositAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GenerateDepositAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "This vault is not for the provided network.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GenerateDepositAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "Address derivation failed due to concurrent requests. Please try again.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GenerateDepositAddressE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/info/{blockchain}/{network}/addresses/validate": { "post": { "tags": [ "Assets & Addresses" ], "operationId": "Validate Address", "summary": "Validate Address", "description": "This endpoint checks user public addresses whether they are valid or not.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "base", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "zcash", "binance-smart-chain", "xrp", "arbitrum", "tron", "solana", "polygon", "optimism", "avalanche" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "devnet", "sepolia", "mordor", "nile", "fuji", "amoy" ] }, "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{networkType}": { "get": { "tags": [ "Vaults" ], "operationId": "List Vaults", "summary": "List Vaults", "description": "This endpoint allows users to retrieve information about their vaults and provides details about each vault's ID, name, backup status, and type (whether it's a test or main vault).", "x-is-list": false, "parameters": [ { "in": "path", "name": "networkType", "required": true, "schema": { "type": "string", "description": "Specifies whether the vault is a main vault or a test vault.", "enum": [ "MAIN", "main", "TEST", "test" ] }, "description": "Specifies whether the vault is a main vault or a test vault." }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVaultsR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/assets/{assetId}/{blockchain}/vaults/{networkType}": { "get": { "tags": [ "Vaults" ], "operationId": "List Vaults by Asset ID", "summary": "List Vaults by Asset ID", "description": "This endpoint allows users to retrieve information about their specific asset in all their vaults.", "x-is-list": false, "parameters": [ { "in": "path", "name": "assetId", "required": true, "schema": { "type": "string", "description": "The specific asset id for the blockchain", "example": "6523e058a06ebf1322d7dd6f" }, "description": "The specific asset id for the blockchain", "example": "6523e058a06ebf1322d7dd6f" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "The specific blockchain, e.g Bitcoin, Ethereum, Binance Smart Chain, Tron.", "example": "bitcoin" }, "description": "The specific blockchain, e.g Bitcoin, Ethereum, Binance Smart Chain, Tron.", "example": "bitcoin" }, { "in": "path", "name": "networkType", "required": true, "schema": { "type": "string", "description": "Specifies whether the vault is a main vault or a test vault.", "default": "test", "enum": [ "main", "test" ] }, "description": "Specifies whether the vault is a main vault or a test vault." }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVaultsByAssetIDR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsByAssetIDE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsByAssetIDE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsByAssetIDE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/vault-accounts/{vaultAccountId}/list-addresses": { "get": { "tags": [ "Assets & Addresses" ], "operationId": "List Addresses by Vault Account ID", "summary": "List Addresses by Vault Account ID", "description": "Retrieves a list of all addresses associated with a specific vault account within a vault, along with their current balances.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultAccountId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the vault account.", "example": "68f0d5ab92a3560007ab5a69" }, "description": "Unique identifier of the vault account.", "example": "68f0d5ab92a3560007ab5a69" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the vault.", "example": "68dfae9739a4b80007c4f706" }, "description": "Unique identifier of the vault.", "example": "68dfae9739a4b80007c4f706" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "assetId", "required": false, "schema": { "type": "string", "description": "Unique identifier of the asset.", "example": "68e4c62889a82e0ff4d8f737" }, "description": "Unique identifier of the asset.", "example": "68e4c62889a82e0ff4d8f737" }, { "in": "query", "name": "blockchain", "required": false, "schema": { "type": "string", "description": "Filters addresses by blockchain, e.g bitcoin, tron, litecoin, solana, binance-smart-chain.", "example": "ethereum" }, "description": "Filters addresses by blockchain, e.g bitcoin, tron, litecoin, solana, binance-smart-chain.", "example": "ethereum" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAddressesByVaultAccountIDR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAddressesByVaultAccountIDE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAddressesByVaultAccountIDE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAddressesByVaultAccountIDE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/assets": { "get": { "tags": [ "Vaults" ], "operationId": "List Assets by Vault", "summary": "List Assets by Vault", "description": "Through this endpoint customers can obtain information about available assets in one of their vaults, regardless of the blockchain protocol or network, by providing vaultId.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Defines the unique ID of the Vault.", "example": "60c9d9921c38030006675ff6" }, "description": "Defines the unique ID of the Vault.", "example": "60c9d9921c38030006675ff6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAssetsByVaultR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/transactions": { "get": { "tags": [ "Vaults" ], "operationId": "List Transactions by Vault", "summary": "List Transactions by Vault", "description": "Through this endpoint customers can obtain details on transaction requests by vault id.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "The sepcific Vault ID.", "example": "6565f9a13f8dcd000760d33a" }, "description": "The sepcific Vault ID.", "example": "6565f9a13f8dcd000760d33a" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByVaultR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/{blockchain}/{network}/{address}/overview": { "get": { "tags": [ "Assets & Addresses" ], "operationId": "Tron Resource Overview", "summary": "Tron Resource Overview", "description": "This endpoint retrieves an overview of TRX staking and resource allocation for a specific address. It provides details on the available TRX balance, staked TRX, and allocated resources (bandwidth/energy), helping users monitor their staking activities.", "x-is-list": false, "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "The address associated with the staking activity.", "example": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4" }, "description": "The address associated with the staking activity.", "example": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Specifies the blockchain used.", "example": "tron" }, "description": "Specifies the blockchain used.", "example": "tron" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Specifies the network used (eg. mainnet , nile).", "example": "mainnet" }, "description": "Specifies the network used (eg. mainnet , nile).", "example": "mainnet" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Represents the specific and unique Vault ID.", "example": "60c9d9921c38030006675ff6" }, "description": "Represents the specific and unique Vault ID.", "example": "60c9d9921c38030006675ff6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronResourceOverviewR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/TronResourceOverviewE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/TronResourceOverviewE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/TronResourceOverviewE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/{blockchain}/{network}/addresses/{fromAddress}/manage-resource": { "post": { "tags": [ "Assets & Addresses" ], "operationId": "Tron Resource Management", "summary": "Tron Resource Management", "description": "Through this endpoint, users can manage TRX staking: freezing, unfreezing, and withdrawing TRX. Stake an amount of TRX to obtain bandwidth or energy and optimize blockchain resource usage. Additionally, users can delegate bandwidth or energy resources to other accounts for efficient transaction processing.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Specifies the blockchain network involved in the transaction (eg. tron).", "example": "tron", "enum": [ "tron" ] }, "description": "Specifies the blockchain network involved in the transaction (eg. tron).", "example": "tron" }, { "in": "path", "name": "fromAddress", "required": true, "schema": { "type": "string", "description": "Represents the originating address from which the transaction is initiated.", "example": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4" }, "description": "Represents the originating address from which the transaction is initiated.", "example": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Specifies the network used (eg. mainnet , nile).", "example": "mainnet", "enum": [ "mainnet", "nile" ] }, "description": "Specifies the network used (eg. mainnet , nile).", "example": "mainnet" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Represents the sender's specific and unique Vault ID of the sender.", "example": "629df9dbae857c00073de9c8" }, "description": "Represents the sender's specific and unique Vault ID of the sender.", "example": "629df9dbae857c00073de9c8" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronResourceManagementRB" } } } }, "responses": { "201": { "description": "The request has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TronResourceManagementR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/TronResourceManagementE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/TronResourceManagementE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Delegation lock period has not expired yet for resources of type: {resource} for address: {toAddress}. Expiry times for the resources: {expireTimes}", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/TronResourceManagementE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The Callback URL has not been verified. Please, verify the URL from within your Dashboard and try again.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/TronResourceManagementE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "TRANSACTION_REQUEST": { "{$request.BODY#/TRANSACTION_REQUEST": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRequest" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_APPROVED": { "{$request.BODY#/TRANSACTION_APPROVED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionApproved" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_REJECTED": { "{$request.BODY#/TRANSACTION_REJECTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRejected" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_BROADCASTED": { "{$request.BODY#/TRANSACTION_BROADCASTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionBroadcasted" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED": { "{$request.BODY#/OUTGOING_MINED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMined" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED_WITH_ERRORS": { "{$request.BODY#/OUTGOING_MINED_WITH_ERRORS": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMinedWithErrors" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_FAILED": { "{$request.BODY#/OUTGOING_MINED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingFailed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/utils/xrp/{network}/addresses/encode/{classicAddress}/{addressTag}": { "get": { "tags": [ "Assets & Addresses" ], "operationId": "Encode XRP Address", "summary": "Encode XRP Address", "description": "This endpoint encodes XRP classic address into an X-Address when classic address and a tag are provided.", "x-is-list": false, "parameters": [ { "in": "path", "name": "addressTag", "required": true, "schema": { "type": "string", "description": "The numeric tag used for the encoding.", "example": "123" }, "description": "The numeric tag used for the encoding.", "example": "123" }, { "in": "path", "name": "classicAddress", "required": true, "schema": { "type": "string", "description": "The classic address that will be encoded.", "example": "rB1QL2KsiwrwaErZ8Pa8dVh3ZEQ2oKGp9J" }, "description": "The classic address that will be encoded.", "example": "rB1QL2KsiwrwaErZ8Pa8dVh3ZEQ2oKGp9J" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "The XRP network to use (mainnet, testnet).", "enum": [ "mainnet", "testnet" ] }, "description": "The XRP network to use (mainnet, testnet)." }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncodeXRPAddressR" } } } }, "400": { "description": "Invalid network! Network MUST be one of: {validNetworks}", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EncodeXRPAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EncodeXRPAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EncodeXRPAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/utils/xrp/{network}/addresses/decode/{xAddress}": { "get": { "tags": [ "Assets & Addresses" ], "operationId": "Decode XRP Address", "summary": "Decode XRP Address", "description": "This endpoint is used to decode an X-Address into classic address and tag.", "x-is-list": false, "parameters": [ { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "The XRP network to use (mainnet, testnet).", "example": "mainnet", "enum": [ "mainnet", "testnet" ] }, "description": "The XRP network to use (mainnet, testnet).", "example": "mainnet" }, { "in": "path", "name": "xAddress", "required": true, "schema": { "type": "string", "description": "The X-Address that has to be decoded", "example": "T7zVRFzUcVxFfE3MUM6jV3SpobVdECBZ1K9UnX62Jacc6AV" }, "description": "The X-Address that has to be decoded", "example": "T7zVRFzUcVxFfE3MUM6jV3SpobVdECBZ1K9UnX62Jacc6AV" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecodeXRPAddressR" } } } }, "400": { "description": "Invalid network! Network MUST be one of: {validNetworks}", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeXRPAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeXRPAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/DecodeXRPAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/transaction-requests/single-transfer": { "post": { "tags": [ "Transactions" ], "operationId": "Create Single Transfer", "summary": "Create Single Transfer", "description": "Through this endpoint users can make coin and token transaction requests for EVM-based, Tron, and Solana blockchains.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://developers.vaultody.com/technical-documentation/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Vaultody will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Sender's Vault ID.", "example": "60c9d9921c38030006675ff6" }, "description": "Sender's Vault ID.", "example": "60c9d9921c38030006675ff6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSingleTransferRB" } } } }, "responses": { "201": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSingleTransferR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateSingleTransferE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateSingleTransferE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "This wallet is not for the provided network.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateSingleTransferE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "Gross amount is only supported for coin transactions. Token transaction fees are paid in the native coin and cannot be deducted from the token amount.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateSingleTransferE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "TRANSACTION_REQUEST": { "{$request.BODY#/TRANSACTION_REQUEST": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRequest" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_APPROVED": { "{$request.BODY#/TRANSACTION_APPROVED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionApproved" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_REJECTED": { "{$request.BODY#/TRANSACTION_REJECTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRejected" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_BROADCASTED": { "{$request.BODY#/TRANSACTION_BROADCASTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionBroadcasted" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED": { "{$request.BODY#/OUTGOING_MINED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMined" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED_WITH_ERRORS": { "{$request.BODY#/OUTGOING_MINED_WITH_ERRORS": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMinedWithErrors" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_FAILED": { "{$request.BODY#/OUTGOING_FAILED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingFailed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "COIN_TRANSACTION": { "{$request.BODY#/COIN_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TOKEN_TRANSACTION": { "{$request.BODY#/TOKEN_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INTERNAL_TRANSACTION": { "{$request.BODY#/INTERNAL_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_COIN_TX": { "{$request.BODY#/INCOMING_CONFIRMED_COIN_TX": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedCoinTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_TOKEN_TX": { "{$request.BODY#/INCOMING_CONFIRMED_TOKEN_TX": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedTokenTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_INTERNAL_TX": { "{$request.BODY#/INCOMING_CONFIRMED_INTERNAL_TX": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedInternalTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/vaults/{vaultId}/transaction-requests/multiple-transfer": { "post": { "tags": [ "Transactions" ], "operationId": "Create Multiple Transfer", "summary": "Create Multiple Transfer", "description": "Through this endpoint users can make UTXO-based transactions.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://developers.vaultody.com/technical-documentation/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Vaultody will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Sender's Vault ID.", "example": "60c9d9921c38030006675ff6" }, "description": "Sender's Vault ID.", "example": "60c9d9921c38030006675ff6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMultipleTransferRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMultipleTransferR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateMultipleTransferE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateMultipleTransferE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "This wallet is not for the provided network.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateMultipleTransferE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "Gross amount is not supported when a fee payer is provided. The fee payer covers the transaction fee separately.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateMultipleTransferE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "TRANSACTION_REQUEST": { "{$request.BODY#/TRANSACTION_REQUEST": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRequest" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_APPROVED": { "{$request.BODY#/TRANSACTION_APPROVED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionApproved" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_REJECTED": { "{$request.BODY#/TRANSACTION_REJECTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRejected" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_BROADCASTED": { "{$request.BODY#/TRANSACTION_BROADCASTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionBroadcasted" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED": { "{$request.BODY#/OUTGOING_MINED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMined" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED_WITH_ERRORS": { "{$request.BODY#/OUTGOING_MINED_WITH_ERRORS": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMinedWithErrors" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_FAILED": { "{$request.BODY#/OUTGOING_FAILED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingFailed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "COIN_TRANSACTION": { "{$request.BODY#/COIN_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_COIN_TX": { "{$request.BODY#/100": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedCoinTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/vaults/{vaultId}/vault-accounts/{vaultAccountId}/transactions": { "get": { "tags": [ "Vault Accounts" ], "operationId": "List Transactions by Vault Account", "summary": "List Transactions by Vault Account", "description": "Retrieves a paginated list of blockchain transactions associated with a specific Vault Account. This endpoint returns sender and recipient details, blockchain metadata, and transaction fees. The endpoint supports cursor-based pagination using the startingAfter parameter to fetch the next page of results.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultAccountId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the vault account whose transactions are being requested.", "example": "699c44632786e90007bf8fb0" }, "description": "Unique identifier of the vault account whose transactions are being requested.", "example": "699c44632786e90007bf8fb0" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Unique identifier of the vault that owns the vault account.", "example": "69932091c938220102488236" }, "description": "Unique identifier of the vault that owns the vault account.", "example": "69932091c938220102488236" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int64", "description": "Defines how many items should be returned in the response per page basis.", "example": 50, "default": 50 }, "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, { "in": "query", "name": "startingAfter", "required": false, "schema": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsByVaultAccountR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultAccountE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultAccountE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultAccountE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/transaction-requests/gas-sponsorship-transfer": { "post": { "tags": [ "Transactions" ], "operationId": "Gas Sponsorship Transfer", "summary": "Gas Sponsorship Transfer", "description": "Through this endpoint users can make coin and token transaction requests for EVM-based, Tron, and Solana blockchains.\r\n\r\n{note}To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks [here](https://developers.vaultody.com/technical-documentation/general-information/callbacks#callback-url).{/note}\r\n\r\n{warning}Vaultody will notify the user **only when** the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification **will not** be sent if the event does not or cannot occur, or will take long time to occur.{/warning}", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Sender's Vault ID.", "example": "60c9d9921c38030006675ff6" }, "description": "Sender's Vault ID.", "example": "60c9d9921c38030006675ff6" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GasSponsorshipTransferRB" } } } }, "responses": { "201": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GasSponsorshipTransferR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GasSponsorshipTransferE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GasSponsorshipTransferE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "This wallet is not for the provided network.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GasSponsorshipTransferE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The token is not supported for this blockchain and network. To be supported, please contact our team.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GasSponsorshipTransferE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "TRANSACTION_REQUEST": { "{$request.BODY#/TRANSACTION_REQUEST": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRequest" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_APPROVED": { "{$request.BODY#/TRANSACTION_APPROVED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionApproved" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_REJECTED": { "{$request.BODY#/TRANSACTION_REJECTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRejected" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_BROADCASTED": { "{$request.BODY#/TRANSACTION_BROADCASTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionBroadcasted" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED": { "{$request.BODY#/OUTGOING_MINED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMined" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED_WITH_ERRORS": { "{$request.BODY#/OUTGOING_MINED_WITH_ERRORS": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMinedWithErrors" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_FAILED": { "{$request.BODY#/OUTGOING_FAILED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingFailed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "COIN_TRANSACTION": { "{$request.BODY#/COIN_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TOKEN_TRANSACTION": { "{$request.BODY#/TOKEN_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INTERNAL_TRANSACTION": { "{$request.BODY#/INTERNAL_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_COIN_TX": { "{$request.BODY#/INCOMING_CONFIRMED_COIN_TX": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedCoinTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_TOKEN_TX": { "{$request.BODY#/INCOMING_CONFIRMED_TOKEN_TX": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedTokenTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_INTERNAL_TX": { "{$request.BODY#/INCOMING_CONFIRMED_INTERNAL_TX": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedInternalTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/vaults/{vaultId}/transaction-requests/batch": { "post": { "tags": [ "Transactions" ], "operationId": "Create Batch Transaction Request", "summary": "Create Batch Transaction Request", "description": "Creates a batch transaction request that groups multiple asset transfers into a single EIP-7702–compliant transaction.\r\nThe batch supports multiple recipient transfers initiated from a single sender and sponsored by a designated fee payer, enabling all operations to execute automically on supported EVM blockchains - Ethereum, Binance Smart Chain, Optimism, Base, Arbitrum, Polygon.", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Sender's Vault ID.", "example": "68dfae9739a4b80007c4f706" }, "description": "Sender's Vault ID.", "example": "68dfae9739a4b80007c4f706" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBatchTransactionRequestRB" } } } }, "responses": { "201": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBatchTransactionRequestR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateBatchTransactionRequestE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateBatchTransactionRequestE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "This wallet is not for the provided network.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateBatchTransactionRequestE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The token is not supported for this blockchain and network. To be supported, please contact our team.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateBatchTransactionRequestE409" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } }, "callbacks": { "TRANSACTION_REQUEST": { "{$request.BODY#/TRANSACTION_REQUEST": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRequest" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_APPROVED": { "{$request.BODY#/TRANSACTION_APPROVED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionApproved" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_REJECTED": { "{$request.BODY#/TRANSACTION_REJECTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRejected" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "TRANSACTION_BROADCASTED": { "{$request.BODY#/TRANSACTION_BROADCASTED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionBroadcasted" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED": { "{$request.BODY#/OUTGOING_MINED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMined" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_MINED_WITH_ERRORS": { "{$request.BODY#/OUTGOING_MINED_WITH_ERRORS": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingMinedWithErrors" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "OUTGOING_FAILED": { "{$request.BODY#/OUTGOING_FAILED": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingFailed" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "COIN_TRANSACTION": { "{$request.BODY#/COIN_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INTERNAL_TRANSACTION": { "{$request.BODY#/INTERNAL_TRANSACTION": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalTransaction" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_COIN_TX": { "{$request.BODY#/INCOMING_CONFIRMED_COIN_TX": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedCoinTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } }, "INCOMING_CONFIRMED_INTERNAL_TX": { "{$request.BODY#/INCOMING_CONFIRMED_INTERNAL_TX": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomingConfirmedInternalTx" } } } }, "responses": { "200": { "description": "A Webhook request expects a response with status code 200 (OK) or it will retry the request." } } } } } } } }, "/vaults/{vaultId}/{blockchain}/transactions/{transactionId}": { "get": { "tags": [ "Transactions" ], "operationId": "Get Transaction Details", "summary": "Get Transaction Details", "description": "Through this endpoint customers can obtain details on a transaction.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain, e.g. Bitcoin, Ethereum, Binance Smart Chain, Tron.", "example": "bitcoin" }, "description": "Represents the specific blockchain, e.g. Bitcoin, Ethereum, Binance Smart Chain, Tron.", "example": "bitcoin" }, { "in": "path", "name": "transactionId", "required": true, "schema": { "type": "string", "description": "Reference number for a particular transaction on the blockchain.", "example": "6e5fd4fc9d12993485cf49dd78d3e8580ad6d11f92fb9211a39ad0601e65ef20" }, "description": "Reference number for a particular transaction on the blockchain.", "example": "6e5fd4fc9d12993485cf49dd78d3e8580ad6d11f92fb9211a39ad0601e65ef20" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Represents the specific vault ID.", "example": "6565f9a13f8dcd000760d33a" }, "description": "Represents the specific vault ID.", "example": "6565f9a13f8dcd000760d33a" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionDetailsR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/approximate-fee": { "post": { "tags": [ "Transactions" ], "operationId": "Estimate Approximate Transaction Fee by Asset ID", "summary": "Estimate Approximate Transaction Fee by Asset ID", "description": "Calculates an approximate fee by Asset ID for a planned transaction before it is submitted. This endpoint supports all transaction types: single transfer, multi transfer, gas sponsorship, and batch transfer. Use this endpoint to estimate costs and validate transaction feasibility prior to execution.\r\n\r\n{note}For each transaction type, the request body follows the same structure as the corresponding transaction endpoint, except for the Batch transaction. For Batch, the fields feePayer and feePayerAssetId are provided as top-level strings within the item object, rather than as nested objects.{/note}", "x-is-list": false, "parameters": [ { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "The unique identifier of the vault from which the transaction will originate.", "example": "69c28b729d1ca8000714911a" }, "description": "The unique identifier of the vault from which the transaction will originate.", "example": "69c28b729d1ca8000714911a" }, { "in": "query", "name": "context", "required": false, "schema": { "type": "string", "example": "yourExampleString" }, "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateApproximateTransactionFeeByAssetIDRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateApproximateTransactionFeeByAssetIDR" } } } }, "400": { "description": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateApproximateTransactionFeeByAssetIDE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "The provided API key is invalid. Please, generate a new one from your Dashboard.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateApproximateTransactionFeeByAssetIDE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/EstimateApproximateTransactionFeeByAssetIDE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2026-03-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } } }, "x-tagGroups": [ { "name": "General Information", "tags": [ "Getting Started", "Vaultody API Authentication", "Data Flow Limiting", "Standards and Conventions", "Webhooks", "Help Center" ] }, { "name": "Rest APIs", "tags": [ "Vaults", "Vault Accounts", "Assets & Addresses", "Transactions" ] } ] }