{ "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": { "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 label that customers can set up for addresses. E.g. custom label named \"User Email Address\".", "example": "yourAddressLabelHere" } }, "required": [ "label" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "EstimateApproximateTransactionFeeRB": { "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": { "contractAddress": { "type": "string", "description": "The contract address. Required only for EVM-based token transactions. Not applicable for UTXO and XRP.", "example": "0x1c7d4b196cb0c7b01d743fbc6116a902379c7238" }, "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast. Not applicable for Tron and Solana.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "prepareStrategy": { "type": "string", "description": "Strategy for preparing transaction - minimize_dust or optimize_size. Required for UTXO-based transactions.", "example": "minimize_dust", "enum": [ "minimize_dust", "optimize_size" ] }, "recipients": { "type": "array", "description": "Required. List of destination addresses.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Address of the destination.", "example": "0x928b77c4e9e8f4ad97592ec9caa953a0fa4730d9" }, "amount": { "type": "string", "description": "Amount to transfer.", "example": "0.001" } }, "required": [ "address", "amount" ] } }, "senders": { "type": "array", "description": "Required for EVM-based transactions. Not applicable for UTXO-based transactions.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Required for EVM-based transactions.", "example": "0xa94b8eca8703ad2804cb204976ac023b612c407e" } } } } }, "required": [ "recipients" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateTokenTransactionRequestRB": { "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": "Represents the specific amount of the transaction.", "example": "0.001" }, "contractAddress": { "type": "string", "description": "Contract address - for Bitcoin-based should be property id e.g 31 for EVM-based shoud be contract e.g 0xdac17f958d2ee523a2206206994597c13d831ec7.", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" }, "feePriority": { "type": "string", "description": "This is required for all EVM-based blockchains, e.g Ethereum, Binance-Smart-Chain, Optimism, Polygon, Avalanche. This does not apply to Tron and Solana.", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "fromAddress": { "type": "string", "description": "Defines the specific source address for the transaction.", "example": "0xd2070342a1a5ce24930ec6582b3db846458525a0" }, "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.004" }, "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" }, "recipientAddress": { "type": "string", "description": "Defines the specific recipient address for the transaction.", "example": "0x8deafae22f7dda381d1a8823c88d1df6df2c57f5" } }, "required": [ "amount", "contractAddress", "fromAddress", "recipientAddress" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateTokenTransactionRequestRISE": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Defines the contract address in the blockchain.", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } }, "description": "Ethereum Erc20 Token", "required": [ "contractAddress" ] }, "CreateTokenTransactionRequestRIST": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Defines the contract address in the blockchain." } }, "description": "Tron Trc20 Token", "required": [ "contractAddress" ] }, "CreateTokenTransactionRequestRISS": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Defines the contract address in the blockchain.", "example": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" } }, "description": "Solana Spl Token", "required": [ "contractAddress" ] }, "CreateTokenTransactionRequestRIS": { "type": "object", "description": "Represents the specific token data.", "oneOf": [ { "$ref": "#/components/schemas/CreateTokenTransactionRequestRISE" }, { "$ref": "#/components/schemas/CreateTokenTransactionRequestRIST" }, { "$ref": "#/components/schemas/CreateTokenTransactionRequestRISS" } ] }, "CreateCoinTransactionRequestRB": { "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": { "feePriority": { "type": "string", "description": "Fee priority of the transaction - slow, standard, fast. Not applicable for Tron and Solana.", "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.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 Bitcoin addresses. Two options available - \"minimize-dust\" (select lower amounts from multiple addresses) or \"optimize-size\" (select higher amounts from less addresses). Not applicable for EVM-based, Tron and Solana blockchains.", "example": "optimize-size", "enum": [ "minimize-dust", "optimize-size" ] }, "recipients": { "type": "array", "description": "Destination of the transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Destination address. For XRP transactions, if the address belongs to the XRP Ledger, and a destinationTag is required, the address must be provided in the X-Address format.", "example": "0x8deafae22f7dda381d1a8823c88d1df6df2c57f5" }, "amount": { "type": "string", "description": "Destination amount.", "example": "0.001" } }, "required": [ "address", "amount" ] } }, "senders": { "type": "array", "description": "Required for EVM-based transactions. Not applicable for UTXO-based transactions.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Required for EVM-based transactions, Tron and Solana. For XRP transactions, if the address belongs to the XRP Ledger, and a sourceTag is required, the address must be provided in the X-Address format.", "example": "0xd2070342a1a5ce24930ec6582b3db846458525a0" } } } } }, "required": [ "note", "recipients" ] } }, "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" ] }, "LinkAddressRB": { "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 that you want to link.", "example": "0xd7861c7b036bc8d4746ddcda457e90d7a066db1d" }, "feePriority": { "type": "string", "description": "Represents the fee priority of the transaction, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "default": "standard", "enum": [ "slow", "standard", "fast" ] } }, "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 field specifies the amount of TRX to freeze, unfreeze, delegate, or undelegate. For these four request types, the amount field is required. When the request type is withdraw-resource, the amount field is not required, as the entire withdrawable amount will be withdrawn.", "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 transaction: **freeze **- lock a specified amount of TRX to obtain either bandwidth or energy; **unfreeze** - release previously frozen TRX and to be withdrawn; **withdraw-resource** - claim TRX and return it to the user’s available balance; **delegate** - assign obtained bandwidth or energy resources to another Tron account; **undelegate** - revoke previously delegated bandwidth or energy from another account, restoring control of those resources to the original owner.", "example": "freeze", "enum": [ "freeze", "unfreeze", "withdraw-resource", "delegate", "undelegate" ] } }, "required": [ "resource", "type" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "GenerateDepositAddressRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Specifies the specific deposit address.", "example": "2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66" }, "createdTimestamp": { "type": "string", "description": "Defines the specific UNIX time when the deposit address was created.", "example": "1624028267" }, "label": { "type": "string", "description": "Represents a custom label that customers can set up for addresses. E.g. custom label named \"User Email Address\".", "example": "yourAddressLabelHere" } }, "required": [ "address", "createdTimestamp", "label" ] }, "GenerateDepositAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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" ] }, "BannedIpAddress": { "type": "object", "description": "banned_ip_address", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "banned_ip_address" }, "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 IP address has been banned. To check the reason for that, please contact 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" ] }, "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" ] }, "GenerateDepositAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "InsufficientCredits": { "type": "object", "description": "insufficient_credits", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "insufficient_credits" }, "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 insufficient credits. Please upgrade your plan from your Dashboard or contact 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" ] }, "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" ] }, "GenerateDepositAddressE400": { "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" ] }, "GenerateDepositAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/VaultAsAServiceDepositAddressesLimitReached" }, { "$ref": "#/components/schemas/VaultAsAServiceProvidedNetworkIsNotSuitableForThisVaultType" } ] }, "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" ] }, "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" ] }, "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" ] }, "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": "2025-09-23" }, "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/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListVaultsByAssetIDRI": { "type": "object", "properties": { "exchangeRateUnit": { "type": "string", "description": "The current exchange rate in USD.", "example": "97014.09" }, "vaults": { "type": "array", "items": { "type": "object", "properties": { "allocatedAmount": { "type": "string", "description": "Allocated amount of the specific asset in the Vault.", "example": "2" }, "availableAmount": { "type": "string", "description": "Available amount of the specific asset in the Vault.", "example": "3.1" }, "totalAmount": { "type": "string", "description": "Total amount of the specific asset in the Vault.", "example": "5.1" }, "vaultColor": { "type": "string", "description": "The specific color of the Vault.", "example": "#FF991F" }, "vaultId": { "type": "string", "description": "Defines the unique ID of the Vault which contains the specific asset.", "example": "654a4ad6d6aeb3000769074d" }, "vaultName": { "type": "string", "description": "The name of the Vault.", "example": "Main Vault" }, "vaultType": { "type": "string", "description": "Represents the type of the Vault, e.g. Smart, General, Automation.", "example": "general", "enum": [ "smart", "general", "automation" ] } }, "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": "2025-09-23" }, "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/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListAssetsRI": { "type": "object", "properties": { "allocatedAmount": { "type": "string", "description": "Allocated amount for the specific asset.", "example": "0" }, "assetId": { "type": "string", "description": "The specific asset ID.", "example": "6523e058a06ebf1322d7dd6f" }, "assetUnit": { "type": "string", "description": "The specific symbol - BTC, ETH, BNB, TRX.", "example": "BTC" }, "availableAmount": { "type": "string", "description": "Available amount for the specific asset.", "example": "0.00023054" }, "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Ethereum etc.", "example": "bitcoin" }, "exchangeRateUnit": { "type": "string", "description": "The current exchange rate in USD.", "example": "39884.82228404232" }, "tokenData": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "The specific contract address.", "example": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3" }, "contractType": { "type": "string", "description": "The specific standard for the token, e.g. TRC-20, BEP-20.", "example": "TRC-20" } }, "required": [ "contractAddress", "contractType" ] }, "totalAmount": { "type": "string", "description": "Total amount for the specific asset.", "example": "0.00023054" }, "type": { "type": "string", "description": "The type of the asset - Coin or Token.", "example": "COIN" } }, "required": [ "allocatedAmount", "assetId", "assetUnit", "availableAmount", "blockchain", "exchangeRateUnit", "totalAmount", "type" ] }, "ListAssetsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/ListAssetsRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListAssetsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListAssetsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListAssetsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$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": "ERC-20" }, "totalAmount": { "type": "string", "description": "Represents the amount of the asset in the particular vault.", "example": "986.1" } }, "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": "BTC" }, "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": "0.9999615316886441" }, "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": "COIN" } }, "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": "2025-09-23" }, "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/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetTransactionRequestDetailsRI": { "type": "object", "properties": { "additionalDetails": { "type": "string", "description": "Defines an optional note for additional details.", "example": "yourExampleStringHere" }, "amountUnit": { "type": "string", "description": "Defines the unit of the amount.", "example": "BTC" }, "blockchain": { "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", "arbitrum", "avalanche", "base", "solana" ] }, "feePriority": { "type": "string", "description": "Defines the priority for the fee, if it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "enum": [ "slow", "standard", "fast" ] }, "network": { "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", "mordor", "nile", "sepolia", "amoy", "fuji", "devnet" ] }, "recipients": { "type": "array", "description": "Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.", "example": "mr3zKBc7skyDHcVHWww4JzzziPnrdYTscR" }, "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 Classic Address.", "example": 3999472835 }, "amount": { "type": "string", "description": "Represents the amount received to this address.", "example": "0.001" }, "amountUnit": { "type": "string", "description": "Defines the unit of the amount.", "example": "BTC" }, "classicAddress": { "type": "string", "description": "Represents the public address, which is a compressed and shortened form of a public key. A classic address is shown when the destination address is an x-Address.", "example": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z" } }, "required": [ "address", "amount", "amountUnit" ] } }, "totalTransactionAmount": { "type": "string", "description": "Defines the total transaction amount.", "example": "0.001" }, "transactionId": { "type": "string", "description": "Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.", "example": "3VsoZeG1n5G7CnNz5GPXnMPuYcWCdi4VPMsDdNuoZcuDJJxNbM5gwVBufR3Vqo7FH8Q7MLhDpXcDB3jorzM6BMAA" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction request, e.g. pending.", "example": "created", "enum": [ "created", "await-approval", "pending", "prepared", "signed", "broadcasted", "success", "failed", "rejected", "mined", "mined-with-errors", "await-approval-l2" ] }, "transactionType": { "type": "string", "description": "Defines the transaction type, if it is for coins or tokens.", "example": "coin", "enum": [ "coin", "token" ] }, "vaultId": { "type": "string", "description": "Defines the unique ID of the Vault.", "example": "60c9d9921c38030006675ff6" } }, "required": [ "additionalDetails", "amountUnit", "blockchain", "feePriority", "network", "recipients", "totalTransactionAmount", "transactionId", "transactionRequestStatus", "transactionType", "vaultId" ] }, "GetTransactionRequestDetailsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/GetTransactionRequestDetailsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTransactionRequestDetailsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTransactionRequestDetailsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTransactionRequestDetailsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "EstimateApproximateTransactionFeeRI": { "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 in blockchain native currency. Bitcoin for BTC, ETH for Ethereum etc.", "example": "0.00001698" }, "maxAmount": { "type": "string", "description": "For UTXO-based transactions. The max amount you can send from the vault with a single transaction request.", "example": "10" } }, "required": [ "errorMessage", "feeInNative" ] }, "EstimateApproximateTransactionFeeR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/EstimateApproximateTransactionFeeRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "EstimateApproximateTransactionFeeE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "EstimateApproximateTransactionFeeE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "EstimateApproximateTransactionFeeE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "CreateTokenTransactionRequestRI": { "type": "object", "properties": { "feePriority": { "type": "string", "description": "Represents the fee priority of the transaction, whether it is \"slow\", \"standard\" or \"fast\".", "example": "slow", "enum": [ "slow", "standard", "fast" ] }, "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" }, "recipients": { "type": "array", "description": "Defines the destination for the transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the destination address.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.001" }, "amountUnit": { "type": "string", "description": "Represents the unit of the tokens amount recieved, e.g. USDT, USDC, JST.", "example": "USDC" } }, "required": [ "address", "amount", "amountUnit" ] } }, "senders": { "type": "object", "description": "Defines details about the source, i.e. the sender.", "properties": { "address": { "type": "string", "description": "Defines the sender's public address.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" } }, "required": [ "address" ] }, "tokenTypeSpecificData": { "$ref": "#/components/schemas/CreateTokenTransactionRequestRIS" }, "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": [ "recipients", "senders", "tokenTypeSpecificData", "transactionRequestId", "transactionRequestStatus" ] }, "CreateTokenTransactionRequestR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/CreateTokenTransactionRequestRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateTokenTransactionRequestE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateTokenTransactionRequestE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateTokenTransactionRequestE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "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" ] }, "CreateTokenTransactionRequestE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceTokenNotSupported" } ] }, "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" ] }, "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" ] }, "CreateCoinTransactionRequestRI": { "type": "object", "properties": { "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": 12345 }, "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": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z" }, "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.001" }, "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": "0x8deafae22f7dda381d1a8823c88d1df6df2c57f5" }, "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": 3999472835 }, "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" }, "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": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z" } }, "required": [ "address", "amount", "amountUnit" ] } }, "senders": { "type": "object", "description": "Defines details about the source, i.e. the sender.", "properties": { "address": { "type": "string", "description": "Required for EVM-based transactions, Tron, and Solana. Not applicable for UTXO-based transactions.", "example": "0xd2070342a1a5ce24930ec6582b3db846458525a0" } } }, "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": [ "note", "recipients", "senders", "totalTransactionAmount", "transactionRequestId", "transactionRequestStatus" ] }, "CreateCoinTransactionRequestR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/CreateCoinTransactionRequestRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateCoinTransactionRequestE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateCoinTransactionRequestE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateCoinTransactionRequestE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateCoinTransactionRequestE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceTokenNotSupported" } ] }, "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": "string", "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": "string", "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 e.g mainnet, testnet, sepolia.", "example": "mainnet" }, "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, smart.", "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, smart.", "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 the transaction.", "example": "completed" }, "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": "2025-09-23" }, "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/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetTransactionDetailsRI": { "type": "object", "properties": { "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, smart.", "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", "addressType", "amount", "amountUnit", "isVaultAddress" ] } }, "status": { "type": "string", "description": "Transaction status, e.g. confirmed, faild.", "example": "confirmed" }, "timestamp": { "type": "integer", "description": "Defines the specific UNIX time when the transaction was created.", "example": 1704881727 }, "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" }, "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": [ "direction", "minedInBlockHeight", "network", "recipients", "senders", "status", "timestamp", "transactionFee" ] }, "GetTransactionDetailsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "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": "2025-09-23" }, "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/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListAssetsByAddressRI": { "type": "object", "properties": { "assets": { "type": "array", "description": "Information about each asset associated with the address.", "items": { "type": "object", "properties": { "assetData": { "type": "object", "description": "Contains data about the asset.", "properties": { "allocatedAmount": { "type": "string", "description": "The allocated amount of the asset associated with the address.", "example": "0" }, "availableAmount": { "type": "string", "description": "The available amount of the asset associated with the address.", "example": "49990" }, "contractAddress": { "type": "string", "description": "The contract address of the asset. Only for token assets.", "example": "0x1c7d4b196cb0c7b01d743fbc6116a902379c7238" }, "standard": { "type": "string", "description": "The standard of the asset e.g. TRC-20, BEP-20, ERC-20 . Only for token assets.", "example": "ERC-20" }, "totalAmount": { "type": "string", "description": "The total amount of the asset associated with the address.", "example": "49990" } }, "required": [ "allocatedAmount", "availableAmount", "totalAmount" ] }, "assetId": { "type": "string", "description": "Represents the specific asset ID.", "example": "6523e058a06ebf1322d7dd6e" }, "assetUnit": { "type": "string", "description": "The symbol of the asset, e.g. ETH, BTC, BNB, USDT, TRX, USDC.", "example": "ETH" }, "blockchain": { "type": "string", "description": "Represents the blockchain of the asset in the particular vault, e.g. ethereum, bitcoin, binance-smart-chain, tron, polygon, base.", "example": "ethereum" }, "exchangeRateUnit": { "type": "string", "description": "The current exchange rate in USD.", "example": "2363.995645367618" }, "network": { "type": "string", "description": "Represents the network of the asset in the particular vault, e.g. mainnet, testnet, sepolia, nile.", "example": "mainnet" }, "type": { "type": "string", "description": "Defines the specific token type or native coin", "example": "TOKEN" } }, "required": [ "assetData", "assetId", "assetUnit", "blockchain", "exchangeRateUnit", "network", "type" ] } } }, "required": [ "assets" ] }, "ListAssetsByAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/ListAssetsByAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListAssetsByAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListAssetsByAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListAssetsByAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListAddressesByVaultAndBlockchainRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Specifies the specific address.", "example": "tb1qa8jcjyf3nlv33jwu2n55fzvgc5q9gapa02fxlz" }, "createdTimestamp": { "type": "string", "description": "Defines the specific UNIX time when the deposit address was created.", "example": "1624028267" }, "id": { "type": "string", "description": "The unique ID of the address.", "example": "654902b79943250007d7bd1d" }, "label": { "type": "string", "description": "Represents a custom label that customers can set up for addresses.", "example": "Address name" }, "type": { "type": "string", "description": "The type of the address e.g. deposit, change, smart address.", "example": "deposit" } }, "required": [ "address", "createdTimestamp", "id", "label", "type" ] }, "ListAddressesByVaultAndBlockchainR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/ListAddressesByVaultAndBlockchainRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListAddressesByVaultAndBlockchainE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListAddressesByVaultAndBlockchainE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListAddressesByVaultAndBlockchainE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$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": { "assetUnit": { "type": "string", "description": "Defines the unit of the amount.", "example": "TRX" }, "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" }, "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": "0" } }, "required": [ "assetUnit", "available", "availableFrozen", "delegated", "total", "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": "2025-09-23" }, "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/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "LinkAddressRI": { "type": "object", "properties": { "feePriority": { "type": "string", "description": "Represents the fee priority of the transaction, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "enum": [ "slow", "standard", "fast" ] }, "transactionRequestId": { "type": "string", "description": "Id of the created transaction.", "example": "6017dd02a309213863be9e55" }, "type": { "type": "string", "description": "Represents the type of a transaction.", "example": "linking", "enum": [ "linking" ] } }, "required": [ "feePriority", "transactionRequestId", "type" ] }, "LinkAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/LinkAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "LinkAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "LinkAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "LinkAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "LinkAddressE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceNoDepositAddressesFound" } ] }, "WalletAsAServiceNoDepositAddressesFound": { "type": "object", "description": "wallet_as_a_service_no_deposit_addresses_found", "properties": { "code": { "type": "string", "description": "Specifies an error code, e.g. error 404.", "example": "wallet_as_a_service_no_deposit_addresses_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": "Please first create a deposit address for the specific blockchain and network, in order to be able to make transactions." }, "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" ] }, "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 involved in the staking action.", "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" ] }, "type": { "type": "string", "description": "The type of staking operation being performed (eg. freeze, unfreeze, withdraw-resource)", "example": "freeze", "enum": [ "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": "2025-09-23" }, "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/BannedIpAddress" }, { "$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" } ] }, "TronResourceManagementE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/CallbackUrlNotVerified" } ] }, "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": "2025-09-23" }, "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/BannedIpAddress" }, { "$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": "2025-09-23" }, "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/BannedIpAddress" }, { "$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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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.", "example": "COIN" } }, "required": [ "blockchain", "network", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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.", "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": [ "blockchain", "network", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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.", "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": [ "blockchain", "network", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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.", "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": [ "blockchain", "network", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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.", "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": [ "blockchain", "network", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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": [ "blockchain", "network", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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.", "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": [ "blockchain", "network", "requestId", "transactionType", "requiredApprovals", "requiredRejections", "currentApprovals", "currentRejections", "failedReason" ] } }, "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "binance-smart-chain" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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": [ "blockchain", "network", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, optimism, polygon, tron).", "example": "binance-smart-chain" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia.", "example": "mainnet" }, "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": [ "blockchain", "network", "address", "minedInBlock", "direction", "currentConfirmations", "targetConfirmations", "amount", "unit", "parentTransactionId", "operationId", "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": { "blockchain": { "type": "string", "description": "The blockchain where the token transfer occurred (e.g., ethereum,binance-smart-chain, solana, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The network name.", "example": "mainnet" }, "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": [ "blockchain", "network", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, binance-smart-chain, tron).", "example": "ethereum" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile.", "example": "mainnet" }, "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": [ "blockchain", "network", "address", "minedInBlock", "currentConfirmations", "targetConfirmations", "amount", "unit", "parentTransactionId", "operationId", "status" ] } }, "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "bitcoin" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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": [ "blockchain", "network", "address", "minedInBlock", "direction", "currentConfirmations", "targetConfirmations", "amount", "unit", "transactionId", "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": { "blockchain": { "type": "string", "description": "The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).", "example": "bitcoin" }, "network": { "type": "string", "description": "The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.", "example": "mainnet" }, "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": [ "blockchain", "network", "address", "minedInBlock", "currentConfirmations", "targetConfirmations", "amount", "unit", "transactionId", "status" ] } }, "required": [ "event", "item" ] } }, "required": [ "walletId", "webhookId", "idempotencyKey", "apiVersion", "data" ] } } }, "security": [ { "ApiKey": [], "ApiSign": [], "ApiTimestamp": [], "ApiPassphrase": [] } ], "info": { "title": "Vaultody", "version": "2025-09-23", "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\n\r\nVaultody offers a comprehensive platform for secure storage and management of digital assets. Our suite includes APIs and SDKs that enable seamless integration of digital asset functionalities into your applications.\r\n\r\n## Supported Protocols and Networks\r\n\r\nVaultody supports a wide range of blockchain protocols and is continually updating to include new assets. For the most current list of supported protocols, visit our [Supported Protocols](https://vaultody.com/integrations/protocols/bitcoin) page.\r\n\r\n## The Dashboard\r\n\r\nUpon account creation, access your personalized Vaultody [Dashboard](https://my.vaultody.com) to:\r\n\r\n- Create vaults\r\n- Generate deposit addresses\r\n- Initiate transaction requests\r\n- Manage funds\r\n- Perform account-related actions\r\n- Access specific API functionalities\r\n- Create API keys with designated access\r\n\r\n## Authenticate Requests\r\n\r\nTo interact with Vaultody's APIs, generate an API key via the Dashboard by clicking on the “Create new API key” button. Multiple API keys can be generated and used concurrently.\r\n\r\n\r\n## Need Help?\r\n\r\nIf you need additional assistance, please visit the [Vaultody Help Center](https://support.vaultody.com/portal/en/home) for FAQs, guides, and direct support." }, { "name": "Vaultody API Authentication", "description": "Vaultody REST API uses HMAC (Hash-based Message Authentication Code) to authenticate and authorize each request. You must sign every API request to ensure security and verify the integrity of communications.\r\n\r\nThis guide explains how to authenticate with Vaultody's API and includes code examples in popular programming languages.\r\n\r\n---\r\n\r\n## Overview\r\n\r\nTo interact with the Vaultody API securely, you need to:\r\n\r\n1. Generate an API Key pair (Key, Secret, Passphrase).\r\n2. Sign each request using the HMAC SHA-256 algorithm.\r\n3. Include the required headers with every request.\r\n\r\n---\r\n\r\n## Authentication Components\r\n\r\n### Required Credentials\r\n\r\n- **API Key (`x-api-key`)**: Public identifier of your application.\r\n- **API Secret**: Used to sign your request (never shared or sent).\r\n- **Passphrase (`x-api-passphrase`)**: Additional user-defined secret for added security.\r\n\r\n---\r\n\r\n## Signature Generation\r\n\r\nTo generate the `x-api-sign` header:\r\n\r\n### 1. Create a message string\r\n\r\nConcatenate the following elements:\r\n\r\n```\r\n{timestamp}{HTTP_METHOD}{request_path}{body}{query_string}\r\n```\r\n\r\n**Examples**:\r\n\r\n- For GET `/vaults/info?currency=BTC` with no body:\r\n ```\r\n 1715709672GET/vaults/info{\"currency\":\"BTC\"}\r\n ```\r\n\r\n- For POST `/vaults/deposit` with body:\r\n ```\r\n 1715709672POST/vaults/deposit{\"currency\":\"BTC\",\"amount\":\"0.5\"}\r\n ```\r\n\r\n### 2. Decode the API secret\r\n\r\n```python\r\ndecoded_secret = base64.b64decode(api_secret)\r\n```\r\n\r\n### 3. Sign the message using HMAC SHA-256\r\n\r\n```python\r\nsignature = hmac.new(decoded_secret, message.encode('utf-8'), hashlib.sha256).digest()\r\n```\r\n\r\n### 4. Encode the signature in Base64\r\n\r\n```python\r\nsignature_b64 = base64.b64encode(signature).decode()\r\n```\r\n\r\n---\r\n\r\n## Required Headers\r\n\r\n| Header Name | Description |\r\n|----------------------|--------------------------------------|\r\n| `x-api-key` | Your public API key |\r\n| `x-api-sign` | Base64-encoded HMAC-SHA256 signature |\r\n| `x-api-timestamp` | UNIX timestamp (in seconds) |\r\n| `x-api-passphrase` | Your passphrase |\r\n| `Content-Type` | Must be `application/json` |\r\n\r\n---\r\n\r\n## Example Usage\r\n\r\n### Python\r\n\r\n```python\r\nimport time, hmac, hashlib, base64, requests\r\n\r\napi_key = 'your_key'\r\napi_secret = 'your_secret'\r\npassphrase = 'your_passphrase'\r\ntimestamp = str(int(time.time()))\r\nmethod = 'GET'\r\nrequest_path = '/vaults/main'\r\nbody = '{}' # Empty JSON object for GET requests\r\nquery = '{}' # Empty JSON object for query parameters\r\n\r\nmessage = timestamp + method + request_path + body + query\r\ndecoded_secret = base64.b64decode(api_secret)\r\nsignature = hmac.new(decoded_secret, message.encode(), hashlib.sha256).digest()\r\nsignature_b64 = base64.b64encode(signature).decode()\r\n\r\nheaders = {\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\nresponse = requests.get('https://rest.vaultody.com' + request_path, headers=headers)\r\nprint(response.json())\r\n```\r\n\r\n### Node.js\r\n\r\n```javascript\r\nconst crypto = require('crypto');\r\nconst axios = require('axios');\r\n\r\nconst apiKey = 'your_key';\r\nconst apiSecret = 'your_secret';\r\nconst passphrase = 'your_passphrase';\r\nconst method = 'GET';\r\nconst requestPath = '/vaults/main';\r\nconst body = '{}'; // Empty JSON object for GET requests\r\nconst query = '{}'; // Empty JSON object for query parameters\r\nconst timestamp = Math.floor(Date.now() / 1000).toString();\r\n\r\nconst message = timestamp + method + requestPath + body + query;\r\nconst hmac = crypto.createHmac('sha256', Buffer.from(apiSecret, 'base64'));\r\nhmac.update(message);\r\nconst signature = hmac.digest('base64');\r\n\r\nconst 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\naxios.get('https://rest.vaultody.com' + requestPath, { headers })\r\n .then(response => console.log(response.data))\r\n .catch(err => console.error(err.response.data));\r\n```\r\n\r\n### POSTMAN\r\n\r\n```\r\nvar CryptoJS = require(\"crypto-js\");\r\nconst secretKey = pm.variables.get(\"x-api-key\");\r\nconst passphrase = pm.variables.get('x-api-passphrase')\r\nconst secret = pm.variables.get('x-api-secret')\r\nconst timestamp = Math.floor(Date.now()/1000).toString();\r\nconst regex = /\\n(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)/g;\r\nvar reqObj = {\r\n method: pm.request.method.toUpperCase(),\r\n path: pm.request.url.getPath(),\r\n body: (pm.request.method === 'GET') ? JSON.stringify({}) :\r\n pm.request.body.raw\r\n .replace(regex, '')\r\n .replace(/(\".*?\")|\\s+/g, '$1'),\r\n query: (pm.request.url.query ? pm.request.url.query : JSON.stringify({}) )\r\n};\r\n\r\nconst transformedQueryObject = reqObj.query.reduce((result, item) => {\r\n result[item.key] = item.value;\r\n return result;\r\n}, {});\r\nvar messageToSign = timestamp + reqObj.method + reqObj.path + reqObj.body + JSON.stringify(transformedQueryObject);\r\n// Decoding the Base64 secret\r\nconst key = CryptoJS.enc.Base64.parse(secret);\r\n// Creating a SHA-256 HMAC with the secret key\r\nconst hmac = CryptoJS.HmacSHA256(messageToSign, key);\r\n// Base64 encoding the result\r\nconst signature = CryptoJS.enc.Base64.stringify(hmac);\r\npm.request.headers.add({\r\n key: \"x-api-timestamp\",\r\n value: timestamp\r\n});\r\npm.request.headers.add({\r\n key: \"x-api-sign\",\r\n value: signature\r\n});\r\npm.request.headers.add({\r\n key: \"x-api-key\",\r\n value: secretKey.toString()\r\n});\r\npm.request.headers.add({\r\n key: \"x-api-passphrase\",\r\n value: passphrase\r\n});\r\npm.request.headers.add({\r\n key: \"Content-Type\",\r\n value: 'application/json'\r\n});\r\n```\r\n\r\n---\r\n\r\n## Security Best Practices\r\n\r\n- Keep your API keys and secrets confidential.\r\n- Use IP whitelisting where applicable.\r\n- Regularly rotate keys.\r\n- Limit API key permissions to necessary scopes.\r\n\r\n---\r\n\r\n## Troubleshooting\r\n\r\n| Error Code | Description | Solution |\r\n|------------|---------------------------------|-------------------------------------------|\r\n| `401` | Unauthorized / Invalid Signature| Check timestamp, body encoding, or secret |\r\n| `403` | Forbidden | Verify API key permissions |\r\n| `400` | Bad Request | Inspect formatting and request body |" }, { "name": "Data Flow Limiting", "description": "## Enabled Features\r\n\r\nVaultody's API data flow limits are determined by your subscription tier. Higher tiers offer advanced features and increased data flow capacities. For subscription details, please [contact us](https://vaultody.com).\r\n\r\n## Using Pagination\r\n\r\nVaultody employs cursor-based pagination for bulk data retrieval in endpoints like addresses, vaults, and transactions. Key parameters include:\r\n\r\n- `limit`: Optional; specifies the number of items per page (default is 50).\r\n- `startingAfter`: Optional; indicates the ID of the last item from the previous page.\r\n\r\n### Example Request\r\n\r\n```http\r\nGET /vaults?limit=50&startingAfter=previousVaultId\r\n```\r\n\r\n### Example Response\r\n\r\n```json\r\n{\r\n \"apiVersion\": \"2023-04-20\",\r\n \"requestId\": \"6579ae4c69f510b1f687c546\",\r\n \"data\": {\r\n \"limit\": 50,\r\n \"hasMore\": true,\r\n \"items\": [\r\n {\r\n \"id\": \"6544bd99e009a200076fac82\",\r\n \"name\": \"Smart Vault\",\r\n \"type\": \"test\",\r\n \"backuped\": false,\r\n \"createdTimestamp\": 1699003801\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n---" }, { "name": "Standards, Conventions, and Versioning", "description": "Vaultody adheres to the OpenAPI 3.0 standard for API documentation. All endpoints are RESTful and follow these conventions:\r\n\r\n- **URI Structure**: `https://rest.vaultody.com/{product-name}/`\r\n- **URI Naming**:\r\n - Lowercase letters with spinal-case for path parameters (e.g., `/vaults/`)\r\n - CamelCase for query parameters and variables (e.g., `?offset=10&limit=0`)\r\n- **HTTPS Only**: All endpoints require HTTPS; HTTP is not supported.\r\n- **URI Length**: Maximum of 2000 characters, including punctuation.\r\n\r\n## Request and Response Standards\r\n\r\n- **Requests**:\r\n - Must be sent via HTTPS to `rest.vaultody.com`\r\n - Headers should include `Content-Type: application/json`\r\n - Custom attributes prefixed with `x-` (e.g., `x-api-key`)\r\n - Public attributes in camelCase\r\n - CORS is enabled, but direct API requests from web applications are discouraged as policies may change.\r\n\r\n- **Responses**:\r\n - Consistent structure with `apiVersion`, `requestId`, and `data` fields.\r\n\r\n## Versioning\r\n\r\nVaultody generates new API versions for backward-incompatible changes. Versions are date-titled, with stable versions marked accordingly. You can select specific API versions and API endpoint to which the API key has access via dashboard.\r\n\r\n---" }, { "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": "## Overview\r\n\r\nWebhooks, or callbacks, are POST requests sent from Vaultody to your specified URL when subscribed events occur. This mechanism allows real-time notifications for events such as transaction requests, approvals, rejections, and incoming transactions.\r\n\r\n## Setting Up Webhooks\r\n\r\n1. **Navigate to Developers Section**: In the Dashboard, go to the Developers menu and select Webhooks.\r\n2. **Add a New Webhook Endpoint**: Click the \"Add Endpoint\" button and enter your desired callback URL.\r\n3. **Authenticate the Request**: Set a secret for your webhook to ensure secure communication.\r\n4. **Select Events**: Choose the events you wish to subscribe to for notifications.\r\n\r\n## Example Payloads\r\n\r\n### Transaction Request\r\n\r\n```json\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"uniqueKey\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"TRANSACTION_REQUEST\",\r\n \"item\": {\r\n \"blockchain\": \"tron\",\r\n \"network\": \"nile\",\r\n \"requestId\": \"65e89fd7e7684b8228dec633\"\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Transaction Approved\r\n\r\n```json\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"uniqueKey\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"TRANSACTION_APPROVED\",\r\n \"item\": {\r\n \"blockchain\": \"tron\",\r\n \"network\": \"nile\",\r\n \"requestId\": \"65e89fd7e7684b8228dec633\",\r\n \"requiredApprovals\": 1,\r\n \"requiredRejections\": 1,\r\n \"currentApprovals\": 1,\r\n \"currentRejections\": 0\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Transaction Reject\r\n\r\n```json\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"acb0ab432a693f604f45cfe08352b02074fa0053990f9e58140d41dfb71472db\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"TRANSACTION_REJECTED\",\r\n \"item\": {\r\n \"blockchain\": \"tron\",\r\n \"network\": \"nile\",\r\n \"requestId\": \"65e069a6e7684b8228ff583a\",\r\n \"requiredApprovals\": 1,\r\n \"requiredRejections\": 1,\r\n \"currentApprovals\": 0,\r\n \"currentRejections\": 1\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Incoming Confirm Coin Transaciton\r\n\r\n```json\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"c989505f082b3463a14d50f9ab785951366fd93012c9869ea1347d8f0b722ea7\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"INCOMING_CONFIRMED_COIN_TX\",\r\n \"item\": {\r\n \"blockchain\": \"binance-smart-chain\",\r\n \"network\": \"testnet\",\r\n \"address\": \"0x6746d7d3f59c1cf062ad25bff246660297122ff2\",\r\n \"minedInBlock\": {\r\n \"height\": 37959320,\r\n \"hash\": \"0x8cff00dcce8c5eecd1bd42bb68b31ac126263cb819133a8e550465cf4426d711\",\r\n \"timestamp\": 1708588551\r\n },\r\n \"currentConfirmations\": 12,\r\n \"targetConfirmations\": 12,\r\n \"amount\": \"0.3\",\r\n \"unit\": \"BNB\",\r\n \"transactionId\": \"0x94405584ed8c2177094f056e7ea6d2c157f3a3e2c1585669e222c5a40d104ef6\"\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Incoming Confirmed Token Transaction\r\n\r\n```json\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"b0c63d216889beb4f6d2154231f1becd2b7d9dbc349a6644cae839b5f35791b1\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"INCOMING_CONFIRMED_TOKEN_TX\",\r\n \"item\": {\r\n \"blockchain\": \"tron\",\r\n \"network\": \"nile\",\r\n \"address\": \"TDGFc6pDe5q2gc9zi4p2JQHfJTXVTBw7yu\",\r\n \"minedInBlock\": {\r\n \"height\": 45323934,\r\n \"hash\": \"0000000002b3969e82281bb3b6d96e88e416d422faaae27a05b8522bc30c83fc\",\r\n \"timestamp\": 1710924012\r\n },\r\n \"currentConfirmations\": 4,\r\n \"targetConfirmations\": 12,\r\n \"tokenType\": \"TRC-20\",\r\n \"transactionId\": \"a6f8225d5a905fc236e5d85d88f77d127d48e80bb456042853c8ed6210182f4f\",\r\n \"token\": {\r\n \"tokenName\": \"Tether USD\",\r\n \"tokenSymbol\": \"USDT\",\r\n \"decimals\": 6,\r\n \"tokensAmount\": \"50000\",\r\n \"contract\": \"TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj\"\r\n }\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Incoming Confirmed Internal Transaction\r\n\r\n```json\r\n{\r\n \"walletId\": \"6577004524a7d60007f63383\",\r\n \"webhookId\": \"65faf3fba2d408b0ffc9fe3d\",\r\n \"idempotencyKey\": \"e1db8b89178b6041039d5d5b94022818370318d1a9d6efef281fa3c93c27044a\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"INCOMING_CONFIRMED_INTERNAL_TX\",\r\n \"item\": {\r\n \"blockchain\": \"binance-smart-chain\",\r\n \"network\": \"testnet\",\r\n \"address\": \"0x81318d093ca1a3a4d33970361f5937b1f3be2265\",\r\n \"minedInBlock\": {\r\n \"height\": 38793161,\r\n \"hash\": \"0x1488f39e69d17cdade73cb3b110e9811c7e2a186afac7cdba3f33806913e40c5\",\r\n \"timestamp\": 1711091362\r\n },\r\n \"currentConfirmations\": 8,\r\n \"targetConfirmations\": 12,\r\n \"amount\": \"0.000001\",\r\n \"unit\": \"BNB\",\r\n \"parentTransactionId\": \"0x354a445437b6795874273d9e578473fceb8e70049c42bf02f14103f4ae871211\",\r\n \"operationId\": \"call\"\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Incoming Mined Transaction\r\n\r\n```json\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"4a159a6f79f0676d251e06eaee0491f7c20ad38987227c793482d4a4b2dbac18\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"INCOMING_MINED_TX\",\r\n \"item\": {\r\n \"blockchain\": \"tron\",\r\n \"network\": \"nile\",\r\n \"address\": \"TDGFc6pDe5q2gc9zi4p2JQHfJTXVTBw7yu\",\r\n \"minedInBlock\": {\r\n \"height\": 45323934,\r\n \"hash\": \"0000000002b3969e82281bb3b6d96e88e416d422faaae27a05b8522bc30c83fc\",\r\n \"timestamp\": 1710924012\r\n },\r\n \"direction\": \"incoming\",\r\n \"currentConfirmations\": 1,\r\n \"targetConfirmations\": 12,\r\n \"tokenType\": \"TRC-20\",\r\n \"transactionId\": \"a6f8225d5a905fc236e5d85d88f77d127d48e80bb456042853c8ed6210182f4f\",\r\n \"token\": {\r\n \"amount\": \"50000\",\r\n \"contractAddress\": \"TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj\",\r\n \"symbol\": \"USDT\",\r\n \"name\": \"Tether USD\",\r\n \"decimals\": 6\r\n }\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Outgoing Transaction Failed\r\n\r\n```json\r\n{\r\n \"apiVersion\": \"2025-09-23\",\r\n \"webhookId\": \"64dcca5c3c61607960b5e02d\",\r\n \"idempotencyKey\": \"e14ab5620c3559334888f122eeef082dc999743f4e0373fedc29a0e2c3383d27\",\r\n \"data\": {\r\n \"event\": \"OUTGOING_FAILED\",\r\n \"item\": {\r\n \"blockchain\": \"xrp\",\r\n \"currentApprovals\": 1,\r\n \"currentRejections\": 0,\r\n \"failedReason\": \"TO_ADDRESS_MUST_BE_DIFFERENT_FROM_SOURCE_ADDRESS\",\r\n \"network\": \"testnet\",\r\n \"requestId\": \"64dccace225244d7f76c2b96\",\r\n \"requiredApprovals\": 1,\r\n \"requiredRejections\": 1\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Outgoing Transaction Mined\r\n\r\n```json\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"23237ea1af1689844e6b4779318a42f042aee630be5a4ebfac98b71521f2c578\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"OUTGOING_MINED\",\r\n \"item\": {\r\n \"blockchain\": \"tron\",\r\n \"network\": \"nile\",\r\n \"requestId\": \"65e89fd7e7684b8228dec633\",\r\n \"requiredApprovals\": 1,\r\n \"requiredRejections\": 1,\r\n \"currentApprovals\": 1,\r\n \"currentRejections\": 0,\r\n \"transactionId\": \"f0509c32db54a723b2934f36964ad67f8ababd2944438c4c4c7ebd140b95f8de\"\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Outgoing Transaction Broadcasted\r\n\r\n```json\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"4cd1ad4ca3e0698017d1e520c93a88142dd122acb975a1786a20f8818924455b\",\r\n \"apiVersion\": \"2025-09-23\",\r\n \"data\": {\r\n \"event\": \"TRANSACTION_BROADCASTED\",\r\n \"item\": {\r\n \"blockchain\": \"tron\",\r\n \"network\": \"nile\",\r\n \"requestId\": \"65e89fd7e7684b8228dec633\",\r\n \"requiredApprovals\": 1,\r\n \"requiredRejections\": 1,\r\n \"currentApprovals\": 1,\r\n \"currentRejections\": 0,\r\n \"transactionId\": \"f0509c32db54a723b2934f36964ad67f8ababd2944438c4c4c7ebd140b95f8de\"\r\n }\r\n }\r\n}\r\n```\r\n\r\n### Customer’s Signing Secret\r\n\r\nThe customer’s request can include data on the event they want to subscribe for and has the option to also have a Signing Secret. This parameter is a required security measure for the benefit of the customer. The Signing Secret can only be generated by the customer. It is used to create a unique hash string in the x-signature response header in the callback request sent from Vaultody when the event occurs.\r\n\r\nThe Signing Secret, and thus the x-signature, are set up per event subscription, not per single callback. Hence, the customer only needs to set up the Signing Secret once when creating the event. They can use a single Signing Secret for all subscriptions, or different ones for each subscription. The security is effective enough even with just one common Signing Secret.\r\n\r\n### Callback Signature\r\n\r\nThe x-signature is provided in the header of the callback and represents a unique hash derived from all the information included in the callback about the event (which must be JSON encoded) and the customer’s Signing Secret.\r\n\r\nFor this purpose, HMAC_SHA256 is used. It stands for Hash-based message authentication code, and along with its cryptographic hash function SHA256, it represents higher security than any other authentication code.\r\n\r\nThe cryptographic strength of the HMAC depends upon the size of the Signing Secret that has been used. The most common attack against HMACs is brute force to uncover the secret key. HMACs are substantially less affected by collisions than their underlying hashing algorithms alone.\r\n\r\nWhen the customer receives the callback request from Vaultody, they can first check the x-signature before processing the request. By using their Signing Secret, which only they would know, together with the information from the callback, they can generate a hash and compare it to the x-signature hash that the Vaultody server has returned. They must match, which only then would authenticate Vaultody as the true sender.\r\n\r\nAfter authentication of the callback, the customer can then proceed to processing it. If the authentication with the x-signature fails, then the customer must ignore it as someone else is sending it.\r\n\r\n## Need Help?\r\n\r\nFor additional support, visit our [Help Center](https://support.vaultody.com/portal/en/home).\r\n\r\n---" }, { "name": "Transactions Fee", "description": "" }, { "name": "Help Center", "description": "Welcome to the Vaultody Help Center—a centralized resource designed to assist you in effectively utilizing Vaultody's suite of digital asset management tools. Whether you're a developer, enterprise user, or new to the platform, our Help Center offers comprehensive guidance to support your needs.\r\n\r\n## Knowledge Base\r\n\r\nExplore our extensive Knowledge Base, which includes detailed articles and guides on:\r\n\r\n- **Getting Started**: Introduction to Vaultody's features and initial setup.\r\n- **API Usage**: Comprehensive documentation on integrating and utilizing Vaultody's APIs.\r\n- **Vault Management**: Instructions on creating and managing General, Smart, and Automation Vaults.\r\n- **Security & Recovery**: Best practices for securing your assets and recovering wallets using the Vaultody Open Source Recovery Tool.\r\n- **Billing & Payments**: Information on subscription plans, billing cycles, and payment methods.\r\n\r\nAccess the Knowledge Base here: [Vaultody Help Center](https://support.vaultody.com/portal/en/home)\r\n\r\n## Community Support\r\n\r\nJoin our support community to:\r\n\r\n- Ask questions and receive answers from Vaultody experts and fellow users.\r\n- Share insights and best practices.\r\n- Stay updated on the latest features and announcements.\r\n\r\nEngage with the community here: [Vaultody Support Community](https://support.vaultody.com/portal/en/community)\r\n\r\n## Announcements\r\n\r\nStay informed about the latest updates, including:\r\n\r\n- **New Features**: Learn about newly released functionalities and how to leverage them.\r\n- **System Updates**: Get notified about maintenance schedules and system enhancements.\r\n- **Security Alerts**: Receive important information regarding security updates and best practices.\r\n\r\nCheck out the latest announcements: [Vaultody Announcements](https://support.vaultody.com/portal/en/news)\r\n\r\n## Contact Support\r\n\r\nIf you need further assistance, our support team is here to help:\r\n\r\n- **Submit a Ticket**: [Contact Support](https://support.vaultody.com/portal/en/newticket)\r\n- **Email**: support@vaultody.com\r\n\r\nOur team is committed to providing timely and effective support to ensure your success with Vaultody." } ], "paths": { "/vaults/{vaultId}/{blockchain}/{network}/addresses": { "post": { "tags": [ "Vaults" ], "operationId": "Generate Deposit Address", "summary": "Generate Deposit Address", "description": "Through this endpoint customers can generate a new Receiving/Deposit Addresses into their Vaults.", "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, Binance Smart Chain, Tron 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, Binance Smart Chain, Tron 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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "The specific type of the vault - main, test.", "example": "main", "default": "main", "enum": [ "main", "test" ] }, "description": "The specific type of the vault - main, test.", "example": "main" }, { "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "The specific type of the vault - main or test.", "example": "test", "default": "test", "enum": [ "main", "test" ] }, "description": "The specific type of the vault - main or test.", "example": "test" }, { "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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/{networkType}": { "get": { "tags": [ "Vaults" ], "operationId": "List Assets", "summary": "List Assets", "description": "Through this endpoint, users can quickly view all their current balances, with the flexibility to filter assets based on their network type, whether it be testnet or mainnet.", "x-is-list": false, "parameters": [ { "in": "path", "name": "networkType", "required": true, "schema": { "type": "string", "description": "The specific type of the vault - MAIN or TEST.", "example": "TEST", "enum": [ "MAIN", "TEST" ] }, "description": "The specific type of the vault - MAIN or TEST.", "example": "TEST" }, { "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/ListAssetsR" } } } }, "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": "2025-09-23" }, "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/ListAssetsE400" } }, "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": "2025-09-23" }, "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/ListAssetsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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/ListAssetsE403" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } } } } }, "/transaction-requests/{transactionRequestId}": { "get": { "tags": [ "Transactions" ], "operationId": "Get Transaction Request Details", "summary": "Get Transaction Request Details", "description": "Through this endpoint customers can obtain details on transaction request.\r\n\r\n{note}This regards **transaction requests**, which is not to be confused with **transactions**. Transaction requests may not be approved due to any reason, hence a transaction may not occur.{/note}", "x-is-list": false, "parameters": [ { "in": "path", "name": "transactionRequestId", "required": true, "schema": { "type": "string", "description": "Represents the unique ID of the transaction request.", "example": "6115126693397c0006f78eb4" }, "description": "Represents the unique ID of the transaction request.", "example": "6115126693397c0006f78eb4" }, { "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/GetTransactionRequestDetailsR" } } } }, "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": "2025-09-23" }, "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/GetTransactionRequestDetailsE400" } }, "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": "2025-09-23" }, "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/GetTransactionRequestDetailsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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/GetTransactionRequestDetailsE403" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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}/approximate-fee": { "post": { "tags": [ "Transactions Fee" ], "operationId": "Estimate Approximate Transaction Fee", "summary": "Estimate Approximate Transaction Fee", "description": "Through this endpoint, customers can estimate the approximate fee for UTXO-based blockchains and EVM-based blockchains. It helps users understand the potential cost of executing a transaction before initiating it.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Blockchain string full name representation (eg. ethereum, bitcoin, litecoin, tron).", "example": "ethereum", "enum": [ "bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "xrp", "zcash", "binance-smart-chain", "tron", "polygon", "optimism", "arbitrum", "base", "avalanche", "solana" ] }, "description": "Blockchain string full name representation (eg. ethereum, bitcoin, litecoin, tron).", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Network string full name representation (eg. mainnet, testnet).", "example": "mainnet", "enum": [ "mainnet", "testnet", "mordor", "nile", "fuji", "sepolia", "amoy", "devnet" ] }, "description": "Network string full name representation (eg. mainnet, testnet).", "example": "mainnet" }, { "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/EstimateApproximateTransactionFeeRB" } } } }, "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateApproximateTransactionFeeR" } } } }, "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": "2025-09-23" }, "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/EstimateApproximateTransactionFeeE400" } }, "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": "2025-09-23" }, "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/EstimateApproximateTransactionFeeE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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/EstimateApproximateTransactionFeeE403" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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}/token-transaction-requests": { "post": { "tags": [ "Transactions" ], "operationId": "Create Token Transaction Request", "summary": "Create Token Transaction Request", "description": "Through this endpoint users can make a single token transaction.\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": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name.", "example": "ethereum", "enum": [ "arbitrum", "avalanche", "base", "binance-smart-chain", "ethereum", "ethereum-classic", "optimism", "polygon", "tron", "solana" ] }, "description": "Represents the specific blockchain protocol name.", "example": "ethereum" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" \"nile\" , \"devnet\" are test networks.", "example": "mainnet", "enum": [ "amoy", "fuji", "mainnet", "mordor", "nile", "sepolia", "testnet", "devnet" ] }, "description": "Represents the name of the blockchain network used, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" \"nile\" , \"devnet\" are test networks.", "example": "mainnet" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "Defines the unique ID of the Vault.", "example": "62b9b5c3b97f4b0008092714" }, "description": "Defines the unique ID of the Vault.", "example": "62b9b5c3b97f4b0008092714" }, { "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/CreateTokenTransactionRequestRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTokenTransactionRequestR" } } } }, "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": "2025-09-23" }, "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/CreateTokenTransactionRequestE400" } }, "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": "2025-09-23" }, "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/CreateTokenTransactionRequestE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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/CreateTokenTransactionRequestE403" } }, "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": "2025-09-23" }, "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/CreateTokenTransactionRequestE409" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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." } } } } }, "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_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}/{blockchain}/{network}/transaction-requests": { "post": { "tags": [ "Transactions" ], "operationId": "Create Coin Transaction Request", "summary": "Create Coin Transaction Request", "description": "Through this endpoint users can make transaction requests for various blockchain types, including EVM-based, UTXO-based, Tron, and Solana blockchains.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Blockchain string full name representation (eg. bitcoin, ethereum, solana, tron).", "enum": [ "bitcoin", "bitcoin-cash", "base", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "xrp", "zcash", "arbitrum", "binance-smart-chain", "tron", "polygon", "optimism", "avalanche", "solana" ] }, "description": "Blockchain string full name representation (eg. bitcoin, ethereum, solana, tron)." }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Network string full name representation (eg. mainnet, testnet).", "enum": [ "mainnet", "testnet", "sepolia", "mordor", "nile", "amoy", "fuji", "devnet" ] }, "description": "Network string full name representation (eg. mainnet, testnet)." }, { "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/CreateCoinTransactionRequestRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCoinTransactionRequestR" } } } }, "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": "2025-09-23" }, "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/CreateCoinTransactionRequestE400" } }, "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": "2025-09-23" }, "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/CreateCoinTransactionRequestE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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/CreateCoinTransactionRequestE403" } }, "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": "2025-09-23" }, "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/CreateCoinTransactionRequestE409" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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}/transactions": { "get": { "tags": [ "Transactions" ], "operationId": "List Transactions by Vault", "summary": "List Transactions by Vault", "description": "Through this endpoint customers can obtain details on transactions 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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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}/transactions/{transactionId}": { "get": { "tags": [ "Transactions" ], "operationId": "Get Transaction Details", "summary": "Get Transaction Details", "description": "Through this endpoint customers can obtain details about specific 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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": [ "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. Bitcoin, Ethereum, Binance Smart Chain, Tron etc.", "example": "bitcoin", "enum": [ "bitcoin", "bitcoin-cash", "base", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "zcash", "binance-smart-chain", "xrp", "arbitrum", "tron", "polygon", "optimism", "avalanche" ] }, "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Ethereum, Binance Smart Chain, Tron 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", "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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}/addresses/{address}/assets": { "get": { "tags": [ "Addresses" ], "operationId": "List Assets by Address", "summary": "List Assets by Address", "description": "This endpoint retrieves a list of all assets associated with a specific address. It supports an optional query parameter blockchain to filter the assets by the blockchain on which they are located.", "x-is-list": false, "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "The address for which all assets will be listed.", "example": "0xb5e561691fe71d5d938a50841a5a09c10359fce6" }, "description": "The address for which all assets will be listed.", "example": "0xb5e561691fe71d5d938a50841a5a09c10359fce6" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "The unique vault ID used for the search.", "example": "66d70e6552fa9a0007ed0963" }, "description": "The unique vault ID used for the search.", "example": "66d70e6552fa9a0007ed0963" }, { "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": "blockchain", "required": false, "schema": { "type": "string", "description": "Filter the results by a specific blockchain. If not provided, assets across all supported blockchains will be returned.", "example": "ethereum", "enum": [ "bitcoin", "bitcoin-cash", "solana", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "xrp", "zcash", "binance-smart-chain", "tron", "polygon", "optimism", "arbitrum", "base", "avalanche" ] }, "description": "Filter the results by a specific blockchain. If not provided, assets across all supported blockchains will be returned.", "example": "ethereum" } ], "responses": { "200": { "description": "The request has been successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAssetsByAddressR" } } } }, "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": "2025-09-23" }, "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/ListAssetsByAddressE400" } }, "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": "2025-09-23" }, "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/ListAssetsByAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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/ListAssetsByAddressE403" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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}/addresses": { "get": { "tags": [ "Addresses" ], "operationId": "List Addresses by Vault and Blockchain", "summary": "List Addresses by Vault and Blockchain", "description": "This endpoint retrieves a list of all addresses associated with a specific vault and blockchain. It supports an optional query parameter blockchain to filter the addresses by the blockchain on which they are created.", "x-is-list": true, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Ethereum, Binance Smart Chain, Tron, etc.", "example": "bitcoin" }, "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Ethereum, Binance Smart Chain, Tron, etc.", "example": "bitcoin" }, { "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" }, { "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/ListAddressesByVaultAndBlockchainR" } } } }, "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": "2025-09-23" }, "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/ListAddressesByVaultAndBlockchainE400" } }, "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": "2025-09-23" }, "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/ListAddressesByVaultAndBlockchainE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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/ListAddressesByVaultAndBlockchainE403" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": [ "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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}/link-address": { "post": { "tags": [ "Transactions" ], "operationId": "Link Address", "summary": "Link Address", "description": "Through this endpoint, users can link addresses from Smart Vault to the Station address with the station address responsible for paying gas fees on behalf of all linked addresses. The linking process does not require approval.\r\n\r\n{note}Linking an address is an on-chain transaction and requires fee which will be paid from the station address in the Smart Vault. Linking is recommended only after having assets on this address which you want to transfer, linking is one timer operation per address..{/note}\r\n\r\n{warning}Completing this step is required before using the station address.{/warning}\r\n\r\n{warning}Linking the address is allowed only for Smart Vaults.{/warning}", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g Ethereum.", "example": "ethereum", "default": "ethereum", "enum": [ "ethereum", "binance-smart-chain", "tron", "polygon", "optimism", "arbitrum", "avalanche", "base" ] }, "description": "Represents the specific blockchain protocol name, e.g Ethereum.", "example": "ethereum" }, { "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 network like \"testnet\", sepolia, nile are test networks.", "example": "mainnet", "enum": [ "mainnet", "testnet", "nile", "sepolia", "amoy", "fuji" ] }, "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 network like \"testnet\", sepolia, nile are test networks.", "example": "mainnet" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "description": "The specific VaultID.", "example": "60c9d9921c38030006675ff6" }, "description": "The specific VaultID.", "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/LinkAddressRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkAddressR" } } } }, "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": "2025-09-23" }, "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/LinkAddressE400" } }, "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": "2025-09-23" }, "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/LinkAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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/LinkAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "Please first create a deposit address for the specific blockchain and network, in order to be able to make transactions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2025-09-23" }, "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/LinkAddressE409" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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_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." } } } } } } } }, "/vaults/{vaultId}/{blockchain}/{network}/addresses/{fromAddress}/manage-resource": { "post": { "tags": [ "Transactions" ], "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.\r\n\r\n{note}There are several types of transactions available through this endpoint. Users must choose the appropriate transaction type when performing an operation.{/note}", "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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." } } } } } } } }, "/utils/xrp/{network}/addresses/encode/{classicAddress}/{addressTag}": { "get": { "tags": [ "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": [ "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": "2025-09-23" }, "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": "2025-09-23" }, "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" ] } } } }, "402": { "description": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact 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": "2025-09-23" }, "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/InsufficientCredits" } }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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": "2025-09-23" }, "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", "Conventions", "and Versioning", "Webhooks", "Help Center" ] }, { "name": "Rest APIs", "tags": [ "Vaults", "Transactions Fee", "Transactions", "Addresses" ] } ] }