{ "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" ] }, "CreateCoinsTransactionRequestFromVaultRB": { "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": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "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" }, "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).", "example": "minimize-dust", "default": "minimize-dust", "enum": [ "minimize-dust", "optimize-size" ] }, "recipients": { "type": "array", "description": "Defines the destination of the transaction, whether it is incoming or outgoing.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the specific recipient/destination address.", "example": "2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66" }, "amount": { "type": "string", "description": "Represents the specific amount of the transaction's destination.", "example": "0.125" } }, "required": [ "address", "amount" ] } } }, "required": [ "feePriority", "recipients" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateCoinsTransactionRequestFromAddressRB": { "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. For XRP we also support the X-address format.", "example": "0.2" }, "feePriority": { "type": "string", "description": "Represents the fee priority of the automation, 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" }, "recipientAddress": { "type": "string", "description": "Defines the specific recipient address for the transaction.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" } }, "required": [ "amount", "feePriority", "recipientAddress" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateCoinsTransactionFromAddressForWholeAmountRB": { "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": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "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" }, "recipientAddress": { "type": "string", "description": "Defines the specific recipient address for the transaction.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" } }, "required": [ "feePriority", "recipientAddress" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateFungibleTokensTransactionRequestFromAddressRB": { "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.2" }, "feePriority": { "type": "string", "description": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "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" }, "recipientAddress": { "type": "string", "description": "Defines the specific recipient address for the transaction.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" }, "tokenIdentifier": { "type": "string", "description": "Defines the specific token identifier. For Ethereum-based transactions - the `contract`.", "example": "0xdac17f958d2ee523a2206206994597c13d831ec7" } }, "required": [ "amount", "feePriority", "recipientAddress", "tokenIdentifier" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateFungibleTokensTransactionRequestFromAddressRISE": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Defines the contract address in the blockchain for an ERC20 token.", "example": "0x534bD102153EF199abAe8296a2FaE4599fC44Cdc" } }, "description": "Ethereum Erc20 Token", "required": [ "contractAddress" ] }, "CreateFungibleTokensTransactionRequestFromAddressRIS": { "type": "object", "description": "Represents the specific token data which depends on its type - if it is a Coin or Token.", "oneOf": [ { "$ref": "#/components/schemas/CreateFungibleTokensTransactionRequestFromAddressRISE" } ] }, "CreateSingleTransactionRequestFromAddressWithoutFeePriorityRB": { "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's destination.", "example": "0.0006" }, "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/destination address.", "example": "TMVeigwYyuXJVHER4oA2yQzsFFSN2JfXkt" } }, "required": [ "amount", "recipientAddress" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityRB": { "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.25684" }, "feeLimit": { "type": "string", "description": "Fee limit of the smart contract. If \"OUT_OF_ENERGY\" error appears - It is necessary to check whether the address of the calling contract has TRX and whether it is enough to pay for the burning energy or bandwidth cost, otherwise the address needs to obtain enough TRX. If there is enough TRX, the feeLimit set by the transaction is smaller, and it needs to be increased.", "example": "1000000000" }, "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": "TMVeigwYyuXJVHER4oA2yQzsFFSN2JfXkt" }, "tokenIdentifier": { "type": "string", "description": "Token identifier - for BITCOIN BASED should be property id e.g 31 for ETHEREUM BASED shoud be contract e.g 0xdac17f958d2ee523a2206206994597c13d831ec7", "example": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3" } }, "required": [ "amount", "recipientAddress", "tokenIdentifier" ] } }, "required": [ "item" ] } }, "required": [ "data" ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityRIST": { "type": "object", "properties": { "contractAddress": { "type": "string", "description": "Defines the contract address in the blockchain for an ERC20 token.", "example": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3" }, "feeLimit": { "type": "string", "description": "Defines the fee limit value.", "example": "1000000000" }, "symbol": { "type": "string", "description": "Defines the Token symbol.", "example": "JST" } }, "description": "Tron Trc20 Token", "required": [ "contractAddress", "feeLimit", "symbol" ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityRIS": { "type": "object", "description": "Represents the specific token data which depends on its type - if it is a Coin or Token.", "oneOf": [ { "$ref": "#/components/schemas/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityRIST" } ] }, "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" ] }, "GenerateDepositAddressRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Specifies the specific deposit address.", "example": "2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific UNIX time when the deposit address was created.", "example": 1624028267 }, "label": { "type": "string", "description": "Represents a custom 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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GenerateDepositAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "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" ] }, "CreateCoinsTransactionRequestFromVaultRI": { "type": "object", "properties": { "feePriority": { "type": "string", "description": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "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 of the transaction, whether it is incoming or outgoing.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the specific destination address.", "example": "mmd963W1fECjLyaDCHcioSCZYHkRwjkhtr" }, "amount": { "type": "string", "description": "Represents the specific amount of the transaction's destination.", "example": "0.00123" } }, "required": [ "address", "amount" ] } }, "totalTransactionAmount": { "type": "string", "description": "Represents the specific 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": "6017dd02a309213863be9e55" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction, e.g. \"created\".", "example": "created", "enum": [ "created" ] } }, "required": [ "feePriority", "recipients", "totalTransactionAmount", "transactionRequestId", "transactionRequestStatus" ] }, "CreateCoinsTransactionRequestFromVaultR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromVaultRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateCoinsTransactionRequestFromVaultE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateCoinsTransactionRequestFromVaultE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateCoinsTransactionRequestFromVaultE403": { "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" ] }, "CreateCoinsTransactionRequestFromVaultE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceNoDepositAddressesFound" } ] }, "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" ] }, "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" ] }, "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" ] }, "CreateCoinsTransactionRequestFromAddressRI": { "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": 3999472835 }, "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": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "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, i.e. the recipient(s).", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the destination address.", "example": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922" }, "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": 3999472835 }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.0023" }, "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" } }, "required": [ "address", "amount" ] } }, "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" ] }, "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": "6017dd02a309213863be9e55" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction request, e.g. \"created\".", "example": "created", "enum": [ "created" ] } }, "required": [ "feePriority", "recipients", "senders", "transactionRequestId", "transactionRequestStatus" ] }, "CreateCoinsTransactionRequestFromAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateCoinsTransactionRequestFromAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateCoinsTransactionRequestFromAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateCoinsTransactionRequestFromAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateCoinsTransactionRequestFromAddressE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" } ] }, "CreateCoinsTransactionFromAddressForWholeAmountRI": { "type": "object", "properties": { "feePriority": { "type": "string", "description": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "standard", "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.Optional Transaction note with additional details", "example": "yourExampleStringHere" }, "recipients": { "type": "array", "description": "Defines the destination for the transaction, i.e. the recipient(s).", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the destination address.", "example": "0xc065b539490f81b6c297c37b1925c3be2f190732" }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.123" } }, "required": [ "address", "amount" ] } }, "senders": { "type": "object", "description": "Details about the sender", "properties": { "address": { "type": "string", "description": "Defines the sender's public address.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" } }, "required": [ "address" ] }, "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": "6017dd02a309213863be9e55" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction, e.g. \"created\".", "example": "created", "enum": [ "created" ] } }, "required": [ "feePriority", "recipients", "senders", "transactionRequestId", "transactionRequestStatus" ] }, "CreateCoinsTransactionFromAddressForWholeAmountR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateCoinsTransactionFromAddressForWholeAmountRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateCoinsTransactionFromAddressForWholeAmountE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateCoinsTransactionFromAddressForWholeAmountE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateCoinsTransactionFromAddressForWholeAmountE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateCoinsTransactionFromAddressForWholeAmountE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" } ] }, "ListVaultsRI": { "type": "object", "properties": { "backuped": { "type": "boolean", "description": "Represents whether the Vault is backuped.", "example": true }, "changeAddressesCount": { "type": "integer", "format": "int64", "example": 3 }, "color": { "type": "string", "example": "#00A3BF" }, "createdTimestamp": { "type": "integer", "example": 1681885776 }, "depositAddressesCount": { "type": "integer", "format": "int64", "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.", "example": "test", "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListVaultsRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListVaultsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListVaultsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListVaultsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "CreateFungibleTokensTransactionRequestFromAddressRI": { "type": "object", "properties": { "feePriority": { "type": "string", "description": "Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\".", "example": "fast", "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, i.e. the recipient(s).", "example": "0x1316bea88fb7cd4ccc4a57e2f9f4f43d1a86ee59", "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": "1" } }, "required": [ "address", "amount" ] } }, "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/CreateFungibleTokensTransactionRequestFromAddressRIS" }, "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": "6038d09050653d1f0e40584c" } }, "required": [ "feePriority", "recipients", "senders", "tokenTypeSpecificData", "transactionRequestId" ] }, "CreateFungibleTokensTransactionRequestFromAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateFungibleTokensTransactionRequestFromAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateFungibleTokensTransactionRequestFromAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateFungibleTokensTransactionRequestFromAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateFungibleTokensTransactionRequestFromAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateFungibleTokensTransactionRequestFromAddressE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceTokenNotSupported" } ] }, "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" ] }, "ListAssetsByVaultRI": { "type": "object", "properties": { "assets": { "type": "array", "items": { "type": "object", "properties": { "assetData": { "type": "object", "properties": { "allocatedAmount": { "type": "string", "example": "0" }, "availableAmount": { "type": "string", "example": "986.1" }, "blockedAmount": { "type": "string", "example": "0" }, "contract": { "type": "string", "example": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3" }, "standard": { "type": "string", "example": "TRC-20" }, "totalAmount": { "type": "string", "example": "986.100000" } }, "required": [ "allocatedAmount", "availableAmount", "blockedAmount", "contract", "standard", "totalAmount" ] }, "blockchain": { "type": "string", "example": "tron" }, "exchangeRate": { "type": "string", "example": "0.9999615316886441" }, "network": { "type": "string", "example": "nile" }, "symbol": { "type": "string", "example": "USDT" }, "type": { "type": "string", "example": "TOKEN" } }, "required": [ "assetData", "blockchain", "exchangeRate", "network", "symbol", "type" ] } } }, "required": [ "assets" ] }, "ListAssetsByVaultR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ListAssetsByVaultRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListAssetsByVaultE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListAssetsByVaultE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListAssetsByVaultE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/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" }, "blockchain": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "ethereum", "binance-smart-chain", "tron" ] }, "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", "nile", "sepolia" ] }, "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" }, "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" }, "unit": { "type": "string", "description": "Defines the unit of the amount.", "example": "BTC" } }, "required": [ "address", "amount", "unit" ] } }, "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": "61922aa68f192800067a8404" }, "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" ] }, "unit": { "type": "string", "description": "Defines the unit of the amount.", "example": "BTC" }, "walletId": { "type": "string", "description": "Defines the unique ID of the Wallet.", "example": "60c9d9921c38030006675ff6" } }, "required": [ "additionalDetails", "blockchain", "feePriority", "network", "recipients", "totalTransactionAmount", "transactionRequestStatus", "transactionType", "unit", "walletId" ] }, "GetTransactionRequestDetailsR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/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" } ] }, "CreateSingleTransactionRequestFromAddressWithoutFeePriorityRI": { "type": "object", "properties": { "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": "TX8VXpdEoNNrKeEuNTfbEXfa9eZivcyUwD" }, "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" }, "recipient": { "type": "array", "description": "Defines the destination for the transaction, i.e. the recipient(s).", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the destination address.", "example": "TX8VXpdEoNNrKeEuNTfbEXfa9eZivcyUwD" }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.0006" }, "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": "TMVeigwYyuXJVHER4oA2yQzsFFSN2JfXkt" }, "unit": { "type": "string", "description": "Defines the unit of the recieved amount for the address.", "example": "TRX" } }, "required": [ "address", "amount", "unit" ] } }, "sender": { "type": "object", "description": "Defines details about the source, i.e. the sender.", "properties": { "address": { "type": "string", "description": "Defines the sender's public address.", "example": "TX8VXpdEoNNrKeEuNTfbEXfa9eZivcyUwD" } }, "required": [ "address" ] }, "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": "62da9f003d20a65c737af83f" }, "transactionRequestStatus": { "type": "string", "description": "Defines the status of the transaction, e.g. \"created\".", "example": "created", "enum": [ "created" ] }, "totalAmount": { "type": "object", "properties": { "unit": { "type": "string", "description": "Defines the unit of the total amount transacted.", "example": "TRX" }, "value": { "type": "string", "description": "Total amount of the transaction", "example": "0.0006" } } } }, "required": [ "recipient", "sender", "transactionRequestId", "transactionRequestStatus" ] }, "CreateSingleTransactionRequestFromAddressWithoutFeePriorityR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateSingleTransactionRequestFromAddressWithoutFeePriorityRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateSingleTransactionRequestFromAddressWithoutFeePriorityE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateSingleTransactionRequestFromAddressWithoutFeePriorityE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateSingleTransactionRequestFromAddressWithoutFeePriorityE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateSingleTransactionRequestFromAddressWithoutFeePriorityE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" } ] }, "ListAddressesByVaultAndBlockchainRI": { "type": "object", "properties": { "address": { "type": "string", "description": "Specifies the specific address.", "example": "2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66" }, "addressType": { "type": "string", "description": "The type of the address (deposit/change).", "example": "change" }, "createdTimestamp": { "type": "integer", "description": "Defines the specific UNIX time when the deposit address was created.", "example": 1624028267 }, "id": { "type": "string", "example": "654902b79943250007d7bd1d" }, "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", "addressType", "createdTimestamp", "id", "label" ] }, "ListAddressesByVaultAndBlockchainR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/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" } ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityRI": { "type": "object", "properties": { "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" }, "recipient": { "type": "array", "description": "Defines the destination for the transaction, i.e. the recipient(s).", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Defines the destination address.", "example": "TMVeigwYyuXJVHER4oA2yQzsFFSN2JfXkt" }, "amount": { "type": "string", "description": "Defines the amount sent to the destination address.", "example": "0.2568" }, "unit": { "type": "string", "description": "Represents the unit of the tokens amount recieved.", "example": "JST" } }, "required": [ "address", "amount", "unit" ] } }, "sender": { "type": "object", "description": "Defines details about the source, i.e. the sender.", "properties": { "address": { "type": "string", "description": "Defines the sender's public address.", "example": "TX8VXpdEoNNrKeEuNTfbEXfa9eZivcyUwD" } }, "required": [ "address" ] }, "tokenTypeSpecificData": { "$ref": "#/components/schemas/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityRIS" }, "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" } }, "required": [ "recipient", "sender", "tokenTypeSpecificData", "transactionRequestId" ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" }, { "$ref": "#/components/schemas/WalletAsAServiceProvidedNetworkIsNotSuitableForThisWalletType" } ] }, "CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityE409": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/WalletAsAServiceWalletBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceAddressBalanceNotEnough" }, { "$ref": "#/components/schemas/WalletAsAServiceTokenNotSupported" } ] }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/ValidateAddressRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ValidateAddressE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ValidateAddressE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ValidateAddressE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "GetTransactionDetailsRI": { "type": "object", "properties": { "direction": { "type": "string", "example": "incoming" }, "internalTransfers": { "type": "array", "items": { "type": "object", "properties": { "fromAddress": { "type": "string", "example": "0xdd06a8b5d79fa90cc4417a66de597eaa97eb141e" }, "operationId": { "type": "string", "example": "call_0_1_0" }, "operationType": { "type": "string", "example": "CALL" }, "previousTxHash": { "type": "string", "example": "0xf2c396008015d3331f0ca54247609af92a0b2c442843a69e10965341659d21d4" }, "timestamp": { "type": "integer", "example": 1701435851 }, "toAddress": { "type": "string", "example": "0x267be1c1d684f78cb4f6a176c4911b741e4ffdc0" } }, "required": [ "fromAddress", "operationId", "operationType", "previousTxHash", "timestamp", "toAddress" ] } }, "minedInBlockHeight": { "type": "string", "example": "1234324" }, "network": { "type": "string", "example": "testnet" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "mku7JSyfdtKNEQb9J6aegZysX7iPWhWcp7" }, "addressType": { "type": "string", "example": "deposit" }, "amount": { "type": "string", "example": "0.0000546" }, "isVaultAddress": { "type": "string", "example": "true" }, "label": { "type": "string", "example": "Bitcoin address" }, "unitSymbol": { "type": "string", "example": "BTC" } }, "required": [ "address", "amount", "isVaultAddress", "unitSymbol" ] } }, "senders": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "n1osMwQ7oy8qr2BrmNZ6mfCBjpfZJQGmEU" }, "addressType": { "type": "string", "example": "deposit" }, "amount": { "type": "string", "example": "0.0000546" }, "isVaultAddress": { "type": "string", "example": "false" }, "label": { "type": "string", "example": "Bitcoin address" }, "unitSymbol": { "type": "string", "example": "BTC" } }, "required": [ "address", "amount", "isVaultAddress", "unitSymbol" ] } }, "status": { "type": "string", "example": "confirmed" }, "timestamp": { "type": "integer", "example": 1704881727 }, "tokensTransfers": { "type": "array", "description": "Information about transaction with token, for example token transaction with token USDT.", "items": { "type": "object", "properties": { "amount": { "type": "string", "example": "50000" }, "contract": { "type": "string", "example": "TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj" }, "decimals": { "type": "integer", "example": 18 }, "fromAddress": { "type": "string", "example": "TVF2Mp9QY7FEGTnr3DBpFLobA6jguHyMvi" }, "symbol": { "type": "string", "example": "USDT" }, "toAddress": { "type": "string", "example": "TS1nMMDbKMFCNfdCBmQLiaA5VUdrG31kra" }, "tokenName": { "type": "string", "example": "Tether USD" }, "type": { "type": "string", "example": "TRC-20" } }, "required": [ "amount", "contract", "decimals", "fromAddress", "symbol", "toAddress", "tokenName", "type" ] } }, "transactionFee": { "type": "object", "properties": { "amount": { "type": "string", "example": "5.96124" }, "unitSymbol": { "type": "string", "example": "BTC" } }, "required": [ "amount", "unitSymbol" ] } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/GetTransactionDetailsRI" } }, "required": [ "item" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "GetTransactionDetailsE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "GetTransactionDetailsE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "GetTransactionDetailsE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListTransactionsByVaultRI": { "type": "object", "properties": { "blockchain": { "type": "string", "description": "The blockchain protoocl.", "example": "tron" }, "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.", "example": "nile" }, "recipients": { "type": "array", "description": "Recipients are all addresses receive assets in this transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The public address itself.", "example": "TKGMSZh4Wf3pVB2gWkUqzU7vwGhRy4H245" }, "addressType": { "type": "string", "description": "The address type (receiving or change).", "example": "deposit" }, "amount": { "type": "string", "description": "The amount for this address", "example": "5.96124" }, "isVaultAddress": { "type": "string", "description": "If this address belongs to this Vault or not.", "example": "true" }, "label": { "type": "string", "description": "The label of this address.", "example": "Tron address" }, "unitSymbol": { "type": "string", "description": "The unit symbol.", "example": "USDT" } }, "required": [ "address", "amount", "isVaultAddress", "unitSymbol" ] } }, "senders": { "type": "array", "description": "Senders are all addresses send assets in this transaction.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "The public address itself.", "example": "TF5mtoWoahGhJiPU4BXXANPvL1kuRwrBoM" }, "addressType": { "type": "string", "description": "The address type (Receiving or Change)." }, "amount": { "type": "string", "description": "The amount for this address.", "example": "0.000001" }, "isVaultAddress": { "type": "string", "description": "If this address belongs to this Vault.", "example": "false" }, "label": { "type": "string", "description": "The address label, in case there is such." }, "unitSymbol": { "type": "string", "description": "The symbol.", "example": "USDT" } }, "required": [ "address", "amount", "isVaultAddress", "unitSymbol" ] } }, "status": { "type": "string", "description": "The status of this transaction.", "example": "confirmed" }, "transactionFee": { "type": "object", "description": "The transaction fee", "properties": { "amount": { "type": "string", "description": "The transaction fee amount", "example": "5.96124" }, "unitSymbol": { "type": "string", "description": "The transaction fee symbol", "example": "TRX" } }, "required": [ "amount", "unitSymbol" ] }, "transactionId": { "type": "string", "description": "The blockchain transaction ID/Hash.", "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Defines how many items should be returned in the response per page basis.", "example": 50 }, "startingAfter": { "type": "string", "description": "Defines the id of the previous listed record id from which the current list should start from.", "example": "5ca21f92cf5431000105d1a7" }, "hasMore": { "type": "boolean", "description": "Defines whether or not there are more elements available after this set.", "example": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransactionsByVaultRI" }, "example": [] } }, "required": [ "limit", "items", "hasMore" ] } }, "required": [ "apiVersion", "requestId", "data" ] }, "ListTransactionsByVaultE401": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MissingApiKey" }, { "$ref": "#/components/schemas/InvalidApiKey" } ] }, "ListTransactionsByVaultE400": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UriNotFound" }, { "$ref": "#/components/schemas/LimitGreaterThanAllowed" }, { "$ref": "#/components/schemas/InvalidPagination" } ] }, "ListTransactionsByVaultE403": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BannedIpAddress" }, { "$ref": "#/components/schemas/EndpointNotAllowedForPlan" }, { "$ref": "#/components/schemas/EndpointNotAllowedForApiKey" }, { "$ref": "#/components/schemas/FeatureMainnetsNotAllowedForPlan" } ] }, "ListAssetsByAddressRI": { "type": "object", "properties": { "assets": { "type": "array", "items": { "type": "object", "properties": { "assetData": { "type": "object", "properties": { "allocatedAmount": { "type": "string", "example": "0" }, "availableAmount": { "type": "string", "example": "49990" }, "blockedAmount": { "type": "string", "example": "0" }, "contract": { "type": "string", "example": "TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj" }, "standard": { "type": "string", "example": "TRC-20" }, "totalAmount": { "type": "string", "example": "49990" } }, "required": [ "allocatedAmount", "availableAmount", "blockedAmount", "contract", "standard", "totalAmount" ] }, "exchangeRate": { "type": "string", "example": "0.9994230956541328" }, "symbol": { "type": "string", "example": "USDT" }, "type": { "type": "string", "example": "TOKEN" } }, "required": [ "assetData", "exchangeRate", "symbol", "type" ] } } }, "required": [ "assets" ] }, "ListAssetsByAddressR": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "data": { "type": "object", "properties": { "item": { "$ref": "#/components/schemas/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" } ] } } }, "security": [ { "ApiKey": [], "ApiSign": [], "ApiTimestamp": [], "ApiPassphrase": [] } ], "info": { "title": "Vaultody", "version": "2023-04-20", "description": "Vaultody", "termsOfService": "https://vaultody.com/terms-conditions", "contact": { "name": "Vaultody Team", "url": "https://vaultody.com/", "email": "developers@vaultody.com" }, "license": { "name": "MIT", "url": "http://www.opensource.org/licenses/mit-license.php" } }, "tags": [ { "name": "Getting Started", "description": "## Introduction\r\n\r\nVaultody is a platform that offers a suite of secure storage and management solutions for digital assets. The Vaultody platform includes a range of APIs (Application Programming Interfaces) and SDKs (Software Development Kits) that allow developers to integrate digital asset storage and management functionality into their applications and systems.\r\n\r\nThe technical documentation for Vaultody provides developers with a comprehensive overview of the platform's APIs, SDKs, and other tools, including their functionality, usage, and integration requirements. The documentation covers a range of topics, including digital asset storage and management protocols, secure key management, and multi-factor authentication.\r\n\r\nYou can download our OpenAPI 3.0 Specification as the latest JSON from [here](https://developers.vaultody.com/download-latest-json).\r\n\r\n{warning}This documentation and all API References apply **only** to Vaultody.{/warning}\r\n\r\n\r\n## Supported Protocols and Networks\r\n\r\nVaultody's support for a wide range of digital assets makes it an ideal platform for developers and businesses looking to securely store and manage their digital assets. The platform is designed to support a variety of blockchain protocols and is constantly updating to support new assets as they become available. [Supported Protocols](https://vaultody.com/integrations/protocols/ethereum). \r\n\r\n## The Dashboard\r\nOnce you create an account, you get access to a personalized Vaultody [Dashboard](https://my.vaultody.com/). \r\n\r\nFrom the Dashboard you can:\r\n\r\n- Creating vaults\r\n- Generating deposit addresses\r\n- Creating transaction requests\r\n- Managing funds\r\n- Performing account-related actions\r\n- Accessing specific features or functionalities of an API\r\n- Create API key with specific access\r\n\r\n## Authenticate requests\r\n\r\nTo use and make calls to Vaultody, you must create an API key, in order for your requests to be authenticated.\r\n\r\nAn API key is a code unique to the user who generated it. It is used to identify the call to the specific API and track the access to it and its usage. You can generate your API key from within the Vaultody [dashboard](https://my.vaultody.com/) by clicking on the “Create new API key” button. You can generate more than one API key and use a single API key more than once.\r\n\r\nFor more information on Authenticating requests, please see [“Authentication”](https://developers.vaultody.com/technical-documentation/api/general-information/authentication) section." }, { "name": "Authentication", "description": "## Create API key\r\n\r\nThe Advanced API Key Permissions feature allows you to manage access to specific functionalities of API keys. To set this up, you need to decide on the permissions you want to assign to the key during the creation.\r\n\r\nYou can generate and manage API keys from within the Vaultody APIs Dashboard [here](https://my.vaultody.com/). By clicking on “Create new API key” you can enter a name and the system will generate a unique for your user key for API authentication. Multiple keys can be generated. Old API keys, that you no longer want to use, can be deleted from the same location.\r\n\r\n## Use API key\r\n\r\nVaultody requires you to create an API key through the Dashboard website to sign a request. When creating a key, you should keep a record of (1) the key, (2) the secret, and (3) the passphrase, which is of your choice and adds an extra layer of security to your API access.\r\n\r\nTo sign a message, you need to generate the X-API-SIGN header by creating a sha256 HMAC using the secret key in base64-decoded format on the prehash string timestamp + method + requestPath + body + query. The output is then base64-encoded.\r\n\r\nExample:\r\n\r\n```\r\n// import crypto library\r\nconst crypto = require('crypto');\r\n\r\n// create the request object\r\nconst timestamp = Math.floor(new Date().getTime() / 1000); // in seconds\r\nconst secret = 'hry/KLGI5cDYzA==';\r\nconst method = 'POST';\r\nconst requestPath = '/transactions';\r\nconst body = JSON.stringify({\r\n amount: '200',\r\n address: '0xE874F9DA2e4702A19c1003Bc87BD47eC739DdcBC',\r\n vaultId: '612e298ad4bd22000791b455'\r\n});\r\n\r\nconst query = JSON.stringify({}); // stringify the query parameters if there are any\r\n\r\n// prepare the prehash string by concatenating the required parts\r\nconst message = timestamp + method + requestPath + body + query;\r\n\r\n// decode the base64 secret\r\nconst key = Buffer.from(secret, 'base64');\r\n\r\n// create a sha256 hmac with the secret\r\nconst hmac = crypto.createHmac('sha256', key);\r\n\r\n// sign the request message with the hmac and base64 encode the result\r\nconst sign = hmac.update(message).digest('base64');\r\n```\r\n\r\n{note}The variable requestPath should only contain the path part of the URL without any query parameters.{/note}\r\n\r\nExample: requestPath /vaults/info/tron/mainnet/supported-tokens\r\n\r\n{note}The query string JSON should only contain string values for its attributes.{/note}\r\n\r\nExample: query = {'context': 'yourExampleString', 'limit': '50', 'offset': '0'}\r\n\r\n{note}The X-API-TIMESTAMP header is required to be in UTC format and must represent the number of seconds since Unix Epoch. Decimal values are allowed.{/note}\r\n\r\n`const timestamp = Math.floor(new Date().getTime() / 1000); // in seconds``\r\n\r\nIt is crucial to ensure that your timestamp is within 30 seconds of the API service time; otherwise, your request will be considered expired and rejected. \r\n\r\nAll REST requests should contain the following headers:\r\n\r\nX-API-KEY: API key as a string\r\n\r\nX-API-SIGN: base64-encoded signature (see Signing a Message)\r\n\r\nX-API-TIMESTAMP: Timestamp for your request\r\n\r\nX-API-PASSPHRASE: Passphrase you specified when creating the API key\r\n\r\n{warning}It's important to secure your API Key against public access. The custom header option is strongly recommended for a production environment.{/warning}" }, { "name": "Data Flow Limiting", "description": "### Enabled features\r\n\r\nAt Vaultody APIs, the features available in each subscription tier determine the data flow limit. Our blockchain-related API products offer a range of options, with higher subscription tiers providing more advanced features to meet your needs and preferences.\r\n\r\nFor more information on our subscription plans and pricing, please do not hesitate to [contact us](https://vaultody.com/request-access). \r\n\r\n### Using Pagination\r\n\r\nPagination\r\nThe load more functionality in the Vaultody API utilizes cursor-based pagination with the \"list\" API methods. Top-level API resources such as addresses, vaults, and transactions support bulk fetches through these methods. The common structure of these methods includes parameters such as \"limit\" and \"startingAfter.\"\r\n\r\nThe \"limit\" parameter is optional and specifies the number of items to be returned in the response per page, with the default value set to 50.\r\n\r\nURL: {{base_url}}/vaults\r\nResponse:\r\n```\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 \"backuped\": false,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1699003801,\r\n \"depositAddressesCount\": 0,\r\n \"id\": \"6544bd99e009a200076fac82\",\r\n \"name\": \"Smart Vault\",\r\n \"type\": \"test\"\r\n },\r\n {\r\n \"backuped\": true,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1698661749,\r\n \"depositAddressesCount\": 4,\r\n \"id\": \"653f857535fe8200078c549f\",\r\n \"name\": \"Vault backup\",\r\n \"type\": \"test\"\r\n },\r\n {\r\n \"backuped\": false,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#8777D9\",\r\n \"createdTimestamp\": 1697699426,\r\n \"depositAddressesCount\": 0,\r\n \"id\": \"6530d66294305800073395eb\",\r\n \"name\": \"Test_Company\",\r\n \"type\": \"test\"\r\n },\r\n {\r\n \"backuped\": false,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1696338115,\r\n \"depositAddressesCount\": 0,\r\n \"id\": \"651c10c39b34e10007ab6c5e\",\r\n \"name\": \"Test\",\r\n \"type\": \"test\"\r\n },\r\n {\r\n \"backuped\": true,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1692257607,\r\n \"depositAddressesCount\": 3,\r\n \"id\": \"64ddcd472f703e0007c12bb2\",\r\n \"name\": \"Company\",\r\n \"type\": \"test\"\r\n },\r\n {\r\n \"backuped\": true,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1690895317,\r\n \"depositAddressesCount\": 3,\r\n \"id\": \"64c903d55299f8000608366d\",\r\n \"name\": \"Test1\",\r\n \"type\": \"main\"\r\n },\r\n {\r\n \"backuped\": false,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00875A\",\r\n \"createdTimestamp\": 1687251940,\r\n \"depositAddressesCount\": 1,\r\n \"id\": \"64916be4b60080000754b32f\",\r\n \"name\": \"Test_Company\",\r\n \"type\": \"test\"\r\n },\r\n {\r\n \"backuped\": true,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1686902903,\r\n \"depositAddressesCount\": 2,\r\n \"id\": \"648c18771cfbcd000773554b\",\r\n \"name\": \"Company\",\r\n \"type\": \"test\"\r\n },\r\n {\r\n \"backuped\": true,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#DE350B\",\r\n \"createdTimestamp\": 1686759097,\r\n \"depositAddressesCount\": 2,\r\n \"id\": \"6489e6b9e1430300073edc4b\",\r\n \"name\": \"Company\",\r\n \"type\": \"main\"\r\n },\r\n {\r\n \"backuped\": true,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00875A\",\r\n \"createdTimestamp\": 1686759052,\r\n \"depositAddressesCount\": 4,\r\n \"id\": \"6489e68ce1430300073edc49\",\r\n \"name\": \"Wallet\",\r\n \"type\": \"main\"\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\nIf you set a limit of 1, you will get only 1 result.\r\n\r\nURL: {{base_url}}/vaults/64463ff167ecf9000707b052/tron/addresses?limit=1\r\nExample: \r\n```\r\n{\r\n \"apiVersion\": \"2023-04-20\",\r\n \"requestId\": \"6579ae8d6b8fa5cb184ab4bb\",\r\n \"data\": {\r\n \"limit\": 1,\r\n \"hasMore\": true,\r\n \"items\": [\r\n {\r\n \"backuped\": false,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1699003801,\r\n \"depositAddressesCount\": 0,\r\n \"id\": \"6544bd99e009a200076fac82\",\r\n \"name\": \"Smart Vault\",\r\n \"type\": \"test\"\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n\r\nThe \"startingAfter\" parameter is also optional and accepts an existing object ID value. It determines the starting point for the current list and returns objects in reverse chronological order. The \"startingAfter\" parameter is mutually exclusive, indicating that it excludes the specified object from the list.\r\n\r\nURL: {{base_url}}/vaults?limit=1&startingAfter=6544bd99e009a200076fac82\r\nResponse:\r\n```\r\n{\r\n \"apiVersion\": \"2023-04-20\",\r\n \"requestId\": \"6579aff569f510b1f687c54b\",\r\n \"data\": {\r\n \"limit\": 1,\r\n \"hasMore\": true,\r\n \"items\": [\r\n {\r\n \"backuped\": true,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1698661749,\r\n \"depositAddressesCount\": 4,\r\n \"id\": \"653f857535fe8200078c549f\",\r\n \"name\": \"Vault backup\",\r\n \"type\": \"test\"\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\n\r\nThe response format includes a \"hasMore\" field, which is a required boolean. This field indicates whether there are additional elements available after the current set. In the provided example, the \"hasMore\" field is set to false, suggesting that there are no more items beyond the ones listed.\r\n\r\nURL: {{base_url}}/vaults?limit=1&startingAfter=6544bd99e009a200076fac82\r\nResponse:\r\n```\r\n{\r\n \"apiVersion\": \"2023-04-20\",\r\n \"requestId\": \"6579aff569f510b1f687c54b\",\r\n \"data\": {\r\n \"limit\": 1,\r\n \"hasMore\": true,\r\n \"items\": [\r\n {\r\n \"backuped\": true,\r\n \"changeAddressesCount\": 0,\r\n \"color\": \"#00A3BF\",\r\n \"createdTimestamp\": 1698661749,\r\n \"depositAddressesCount\": 4,\r\n \"id\": \"653f857535fe8200078c549f\",\r\n \"name\": \"Vault backup\",\r\n \"type\": \"test\"\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n\r\nIn summary, the load more functionality in Vaultody API implements cursor-based pagination, allowing users to retrieve a specified number of items per page and navigate through the list using the \"startingAfter\" parameter, while the \"hasMore\" field in the response signals the availability of more elements." }, { "name": "Standards Conventions and Versioning", "description": "## Standards and Conventions\r\n\r\nThis article will present and describe principles, standards and conventions we apply to our APIs and processes. The following information may be subject to change and may as well not apply to other software.\r\n\r\nWe use OpenAPI 3 Standard for our Technical Documentation and Endpoints description. All Technical Documentation can be found in the [Developer’s Portal](https://developers.vaultody.com/technical-documentation). Moreover, all Vaultody endpoints are REST.\r\n\r\n## Vaultody Versioning\r\nAn additional feature in the Vaultody system allows us to generate new API versions of our endpoints each time backwards-incompatible changes have been made to them. Versions are generally titled with a date and \"stable\" versions are marked as such.\r\nYou can try out new features and changes in our newer versions not marked as \"stable\".\r\nOur technical documentation lists all available API versions. To view a specific one, select it from the drop down menu.\r\nAll requests use your account's API version, unless you override the API version with a header.\r\n\r\n## URI\r\n\r\n### URI Structure\r\n\r\nThe Vaultdoy and endpoint URIs follow the RFC 3986 specification and are divided into two main parts, applicable to all Vaultody endpoints : The domain and subdomain in the URI always display as: **rest.vaultody.com\r\n\r\n1. The domain and subdomain in the URI always display as: **rest.vaultody.com**\r\n2. Next is displayed the product name, where words are separated with spinal-case: **/vaults/**\r\n\r\n### URI Naming Standards\r\n\r\nURIs have to follow the naming standards as listed below:\r\n\r\n- the URI has to be written in all lower cases, except when a specific string requires capital letters;\r\n- the path parameter must use spinal-case ( a hyphen - ) to separate words, e.g. **/vaults/**;\r\n- the query parameters must use camelCase to differentiate words, e.g. **/vaults/bitcoin/addresses?offset=10&limit=0**;\r\n- the variables must use camelCase to differentiate words, e.g. **/vaults/bitcoin/addresses/${bitcoinValidAddress}**;\r\n- all URLs must be **HTTPS** - secured, using only HTTP is not accepted.\r\n\r\n\r\n### URI Maximum Length\r\n\r\nThe entire URI cannot exceed 2000 characters in length including any punctuation marks, e.g. commas, hyphens, question marks, pluses or forward slashes.\r\n\r\n\r\n## Request and Response Standards\r\n\r\n### Basic API Request \r\n\r\nMain prerequisites for requests to the Vaultody APIs include:\r\n\r\n- requests are sent through HTTPS only to the domain **rest.vaultody.com**;\r\n- headers must by default incorporate the JSON content type **application/json**;\r\n- all custom for Vaultody attributes are indicated in the beginning with an `x-`, e.g. `x-attribute`;\r\n- request public attributes must be all camelCase, e.g. `\"attributeName\": \"attributeValue\"`;\r\n- we enable CORS (Cross-Origin Resource Sharing), for which the API responds with an `Access-Control-Allow-Origin:` header. **Nevertheless**, your users **shouldn’t make** direct API requests from a web application that you are building, as our CORS policy may change at some point without warning and any such requests could be then rejected;\r\n- no random unspecified keys can be added to the Vaultdoy URI, e.g. `?randomKey=randomUnspecifiedValue`, as that will result in a 400 error;\r\n- all requests to the Vaultody **must** be authenticated with an API key. Owner can generate API keys through the dedicated [Dashboards](https://my.vaultody.com/) only after product subscription. Multiple API keys can be generated. \r\n- API keys must be kept secure and private by the users who own them. API keys **must not** be uploaded to a frontend of a mobile or web application or in any open source code, as API keys represent access to the user’s account and the data inside.\r\n\r\n{tip}Best to use one API key for testing and integration purposes, and a separate one for production, known to only a limited number of people.{/tip}\r\n\r\nShortly put, all Vaultdoy API requests include:\r\n\r\n```\r\nREST API Base URL: https://rest.vaultody.com\r\nAuthentication (API Key + JSON)\r\nRequest Type (GET, POST, PUT, PATCH, DELETE)\r\n```\r\n\r\nOur API Requests incorporate the following HTTP methods:\r\n\r\n| HTTP method | Definition |\r\n|:---:|:---:|\r\n| GET | Retrieve a specified resource/information from the server. |\r\n| POST | Send data to the server and requests to accept it. |\r\n| PUT | Updates a resource. |\r\n| PATCH | Partially updates a resource. |\r\n| DELETE | Deletes a resource. |\r\n\r\n**POST** requests always contain the following body structure:\r\n\r\n\r\n```\r\n{\r\n\t\"context\": \"You can add any text here.\", // Optional: In case you send this value in the request.\r\n\t\"data\": { // Contains the request parameters.\r\n\t\t\"item\": { // Single item’s details.\r\n\t\t\t\"endpointAttribute\": \"value\" // Parameter data.\r\n\t\t}\r\n\t}\r\n}\r\n```\r\n\r\nIf an endpoint has no parameters, the body structure has less data:\r\n\r\n```\r\n{\r\n\t\"context\": \"You can add any text here\", // Optional: In case you send this value in the request.\r\n\t\"data\": { // Contains the request parameters.\r\n\t\t\"item\": { } // Single item’s details.\r\n\t}\r\n}\r\n```\r\n\r\n\r\n\r\n### Basic API Response\r\n\r\nResponses to Vaultody APIs requests prerequisites: \r\n\r\n- response public attributes must be all camelCase, e.g. `”apiVersion”: 2`, `”customAttribute”: \"customAttribute\"`;\r\n- Vaultody APIs requests always return the following parameters:\r\n\r\n```\r\n{\r\n \"requestId\": \"\",\r\n \"context\": \"\",\r\n \"data\": {\r\n \"item\": {\r\n }\r\n }\r\n}\r\n```\r\n\r\n- `requestId` is a unique code used with the purposes of tracking, support, etc.;\r\n- the attribute `data` always contains the result, no matter of the quantity of items in it;\r\n- the attribute `item` specifies the response’s result indicating there is only a single one, when listed as `items` it means there are two or more results, i.e. a list of results, in the response;\r\n- all calculated prices are always in USD currency;\r\n- we use pagination methods to limit the results in the response, specifically on responses that can potentially return hundreds or thousands of results, please see more information in our [Data Flow Limiting section](https://developers.vaultody.com/technical-documentation/api/general-information/data-flow-limiting).\r\n\r\n\r\n### The `context` parameter\r\n\r\nThe `context` parameter is an optional attribute created with the idea to facilitate users when they make requests in bulk.\r\n\r\nThey can set the `context` attribute as a string with simple text of their choosing. Afterwards each returned information will contain the specific `context` string of its associated request. Through this process users can keep track of the responses that come in.\r\n\r\nFor **GET** requests the attribute can be set as a query parameter. For **POST** requests it can be set as a query or body parameter. In the latter scenario there’s a safety measure embedded in case the user sets `context` as both a query and body parameter - the system will then take into account the body `context` attribute.\r\n\r\n\r\n\r\n## Error and HTTP Code Standards\r\n\r\nThe page below contains a comprehensive compilation of errors.\r\n\r\nThe errors we use follow the HTTP Error Codes Standard. \r\n\r\n| HTTP Status Code | Error it represents |\r\n|:---:|:---:|\r\n|3xx | Redirection Error |\r\n|4xx | Client Error |\r\n|5xx | Server Error |\r\n\r\n\r\nThe structure of the error **always** returns the following values, as listed and described in the example:\r\n\r\n\r\n_**Example:**_\r\n\r\n```\r\n{\r\n \"requestId\": \"\", // Each request has a unique ID, for which the Support team could ask for when contacted.\r\n \"context\": \"\", // Optional: In case you send this value in your request.\r\n \"error\": {\r\n \"code\": \"\", // Error Code, please check our [Errors page](https://developers.vaultody.com/technical-documentation/general-information) to see the full list of error codes.\r\n \"message\": \"\", // Is the human readable error message.\r\n \"details\": \"\" // Optional: Some errors may need more details.\r\n }\r\n}\r\n```\r\n\r\n## List of errors\r\n\r\nAll requests with a response status code different than 200 (successful HTTP) are considered as a failure of the particular API call and referred to as “HTTPS errors”. When the response (error) is returned an additional JSON is present in the body containing the error message. Depending on what has gone wrong with the API call, the error message is different.\r\n\r\nAs best practice we recommend to store all error messages somewhere along with request data for further manual review.\r\n\r\nThe errors we use follow the HTTP Error Codes Standard. \r\n\r\n| HTTP Status Code | Error it represents |\r\n|:---:|:---:|\r\n|3xx | Redirection Error |\r\n|4xx | Client Error |\r\n|5xx | Server Error |\r\n\r\n\r\nThe structure of the error **always** returns the following values, as listed and described in the example:\r\n\r\n\r\n_**Example:**_\r\n\r\n```\r\n{\r\n \"apiVersion\": \"\", // The current API Version.\r\n \"requestId\": \"\", // Each request has a unique ID, for which the Support team could ask for when contacted.\r\n \"context\": \"\", // Optional: In case you send this value in your request.\r\n \"error\": {\r\n \"code\": \"\", // Error Code, please check our [Errors page](https://developers.vaultody.com/technical-documentation/api/general-information) to see the full list of error codes.\r\n \"message\": \"\", // Is the human readable error message.\r\n \"details\": \"\" // Optional: Some errors may need more details.\r\n }\r\n}\r\n```\r\n\r\nWe use the following error codes:\r\n\r\n\r\n### General errors\r\n\r\n| Type of code | HTTP Status Code | Error code | Message |\r\n| :---: | :---: | :---: | :---: |\r\n| Client Error | 400 | `uri_not_found` | \"The specified URI has not been found. Check the URI and try again.\" |\r\n| | | `limit_greater_than_allowed` | \"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.\" |\r\n| | | `invalid_pagination` | \"The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.\" |\r\n| | 401 | `missing_api_key` | \"The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.\" |\r\n| | | `invalid_api_key` | \"The provided API key is invalid. Please, generate a new one from your Dashboard.” |\r\n| | 403 | `https_required` | \"The use of HTTP**S** is required.\" |\r\n| | | `endpoint_not_allowed_for_plan` | \"This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.\" |\r\n| | | `data_not_allowed_for_plan` | \"Your subscription plan includes only {days} days of historical data. Please upgrade your plan or contact our team for more information.\" |\r\n| | | `banned_ip_address` | \"This IP address has been banned. To check the reason for that, please contact our team via email.\" |\r\n| | | `endpoint_not_allowed_for_api_key` | “This endpoint is not available for your API key.” |\r\n| | 404 | `resource_not_found` | \"The specified resource has not been found.\" |\r\n| | 405 | `request_method_not_supported` | \"The specified request method ({method}) is not supported for this endpoint. Please check our Documentation and make sure you set the right request method.\" |\r\n| | | `allowed_methods` | \"The specified method **must** be one of the following: {methods}.\" |\r\n| | 409 | `invalid_query_parameter` | \"The query parameter provided is invalid. Please provide a proper query parameter, or refer to the documentation for more information.\" |\r\n| | | `missing_request_body` | \"The required request body is missing, action cannot be performed.\" |\r\n| | | `bad_json` | \"The JSON provided is invalid. Please make sure it's valid and try again.\" |\r\n| | | `invalid_data` | \"The data provided seems to be invalid.\" |\r\n| | | `already_exists` | \"The specified resource already exists.\" |\r\n| | | `missing_required_attributes` | \"A required parameter is missing. Please provide all required parameters, or refer to the documentation for more information.\" |\r\n| | | `extra_body_attributes` | \"A provided body parameter is unknown or not specified. Please provide only specified body parameters, or refer to the documentation for more information.\" |\r\n| | | `extra_query_attributes` | \"A provided query parameter is unknown or not specified. Please provide only specified query parameters, or refer to the documentation for more information.\" |\r\n| | 415 | `unsupported_media_type` | \"The selected Media Type is unavailable. The Content-Type header should be 'application/json'.\" |\r\n| | 429 | `request_limit_reached` | \"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.\" |\r\n| Server Error | 500 | `technical_issues` | \"We are currently facing some technical issues, please try again later.\" |\r\n| | | `unexpected_server_error` | \"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.\" |\r\n| | 501 | `unimplemented` | \"This {feature} has not been implemented yet.\" |\r\n| | 503 | `temporary_shutdown_endpoint` | \"This endpoint is temporarily stopped due to performance reasons. For more information please contact our team via email.\" |\r\n\r\n\r\n### Custom errors:\r\n\r\n| Type of code | HTTP Status Code | Error code | Message |\r\n| :---: | :---: | :---: | :---: |\r\n| Client Error | 400 | `invalid_blockchain` | \"The provided blockchain is invalid. The blockchain **must** be a supported one. For the full list of supported blockchains please see our Documentation.\" |\r\n| | | `invalid_network` | \"The provided network is invalid. The network **must** be a supported one. For the full list of supported networks please see our Documentation.\" |\r\n| | | `waas_contact_group_is_missing` | \"Contact group was not found.\" |\r\n| | 403 | `wallet_as_a_service_contacts_limit_reached` | \"You have reached the maximum Contacts count which is currently {waasConstraintsCount}. 'Please, upgrade your plan in order to have a higher Contacts count.\" |\r\n| | | `wallet_as_a_service_deposit_addresses_limit_reached` | \"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.\" |\r\n| | | `wallet_as_a_service_wallets_limit_reached` | You have reached the maximum Wallets count which is currently {walletsCount}. Please, upgrade your plan in order to have a higher Wallet count. |\r\n| | | `wallet_as_a_service_wallet_recovery_data_already_backed_up` | \"Your Wallet has been already backed up and that action cannot be done again. For further assistance please contact our team.\" |\r\n| | | `action_requests_user_cannot_approve_request` | \"User with ID: {userId} cannot approve this action request.\" |\r\n| | | `action_requests_request_already_approved_by_this_user` | \"User with ID: {userId} has already approved this action request.\" |\r\n| | | `action_requests_user_cannot_reject_request` | \"User with ID: {userId} cannot reject this action request.\" |\r\n| | 409 | `wallet_as_a_service_token_not_supported` | \"The token is not supported for this blockchain and network. To be supported, please contact our team.\" |\r\n| | | `wallet_as_a_service_no_deposit_addresses_found` | \"Please first create a deposit address for the specific blockchain and network, in order to be able to make transactions.\" |\r\n| | | `wallet_as_a_service_tokens_not_supported` | \"Tokens are not supported for the blockchain specified.\" |\r\n| | | `wallet_as_a_service_address_balance_not_enough` | \"Your address balance is insufficient to complete the action. Please, deposit funds to your address and try again.\" |\r\n| | | `wallet_as_a_service_wallet_balance_not_enough` | \"Your Wallet balance is insufficient to complete the action. Please, deposit funds to your Wallet and try again.\" |\r\n\r\n## Date and Time Formats\r\n\r\nFor all required endpoints that use a time parameter, the accepted value is `timestamp` which is always UTC-based by definition. The human date which corresponds to the `timestamp` is always converted by the system to UNIX Epoch time and returned as an integer.\r\n\r\n_**Example:**_\r\n\r\nHuman time: 09:12:41 AM 28th January 2021\r\n\r\nWhich corresponds to:\r\n\r\nUNIX Epoch time: 1611825161\r\n\r\nHence the system will return `”timestamp”: 1611825161` and not the human time.\r\n\r\nThe UNIX Epoch time is a system that describes a point in time. This would be the amount of time in seconds that have passed since the Unix Epoch which was 00:00:00 UTC on 1 January 1970, minus leap seconds." }, { "name": "Generating", "description": "This category displays Vaults endpoints which can be used to generate addresses for a Vault." }, { "name": "Transactions", "description": "This category displays Vaults endpoints which can be used to create transactions." }, { "name": "Informative", "description": "This category displays Vaults endpoints which can be used to obtain information for the Vault such as list deposit addresses." }, { "name": "Utils", "description": "This category displays Vaults endpoints with useful features and tools for blockchain and crypto operations." }, { "name": "Webhooks", "description": "## Callbacks and Main Terminology\r\n\r\nLet's first define some main vocabulary related to callbacks that will make the process easier to talk about.\r\n\r\n\r\n### Callback\r\n\r\nShortly put, a “callback” is a POST request sent from Vaultody to a customer’s Callback URL when an event they have already subscribed for occurs.\r\n\r\nNow with a bit more detail, a “callback” is used to describe an event reaction process where a user receives notifications on certain events after having first subscribed to them in the system. The term has become interchangeable with the word “webhook” which is used to describe the same thing. Callbacks can be very useful for customers who want to be notified about the state of transactions on the blockchain.\r\n\r\nThere are two sides to the callback - the server side and the customer side. The process involves customers subscribing to events on the server side. Once an event is completed, the server side notifies the customer side about it.\r\n\r\n\r\n\r\n### Callback \r\n#### Definition\r\n\r\n\r\nSpecific processes are considered \"events”. Simply put, an “event” is something that occurs on the Blockchain. Vaultody incorporates various endpoints, which hold different characteristics. You can see endpoints that represent events to which users can subscribe for a callback on our Dashboard.\r\n\r\n\r\nSpecific processes are considered \"events”. Simply put, an “event” is something that occurs on the Blockchain. Vaultody incorporates various endpoints, which hold different characteristics.\r\n\r\n#### Types\r\n\r\nDifferent callback types exist, with a focus on the following:\r\n\r\nTransaction request-\r\n```\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"d14d2f41c0c2aef3f699ef2da79bc673ea5893eddf5966b7dde9fdde0e34b750\",\r\n \"apiVersion\": \"2023-04-20\",\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\nTransaction approved -\r\n```\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"e5a10cfa989cf5b589ff1a6e7ca37ba1fe5307e26d41012e83cbf5db0a2fc31c\",\r\n \"apiVersion\": \"2023-04-20\",\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\nTransaction rejected -\r\n```\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"acb0ab432a693f604f45cfe08352b02074fa0053990f9e58140d41dfb71472db\",\r\n \"apiVersion\": \"2023-04-20\",\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\r\n\r\nIncoming confirmed coin transaction -\r\n```\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"c989505f082b3463a14d50f9ab785951366fd93012c9869ea1347d8f0b722ea7\",\r\n \"apiVersion\": \"2023-04-20\",\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\nIncoming confirmed token transaction -\r\n```\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"b0c63d216889beb4f6d2154231f1becd2b7d9dbc349a6644cae839b5f35791b1\",\r\n \"apiVersion\": \"2023-04-20\",\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\nIncoming confirmed internal transaction -\r\n```\r\n{\r\n \"walletId\": \"6577004524a7d60007f63383\",\r\n \"webhookId\": \"65faf3fba2d408b0ffc9fe3d\",\r\n \"idempotencyKey\": \"e1db8b89178b6041039d5d5b94022818370318d1a9d6efef281fa3c93c27044a\",\r\n \"apiVersion\": \"2023-04-20\",\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\nIncoming Mined transaction -\r\n```\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"4a159a6f79f0676d251e06eaee0491f7c20ad38987227c793482d4a4b2dbac18\",\r\n \"apiVersion\": \"2023-04-20\",\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\nOutgoing transaction failed - \r\n\r\n```\r\n{\r\n \"apiVersion\": \"2023-04-20\",\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\r\nOutgoing transaction mined - \r\n```\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"23237ea1af1689844e6b4779318a42f042aee630be5a4ebfac98b71521f2c578\",\r\n \"apiVersion\": \"2023-04-20\",\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\nOutgoing transaction broadcasted - \r\n```\r\n{\r\n \"walletId\": \"64463ff167ecf9000707b052\",\r\n \"webhookId\": \"65b2633879435ab2f30727ff\",\r\n \"idempotencyKey\": \"4cd1ad4ca3e0698017d1e520c93a88142dd122acb975a1786a20f8818924455b\",\r\n \"apiVersion\": \"2023-04-20\",\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\r\n### Callback URL\r\n\r\nCallbacks require what is known as a **”Callback URL”**. It is the destination where Vaultody sends the callback notification. Setting up this URL is done entirely on the customer’s side and is the first step to setting up a Callback. \r\n\r\n\r\n## Vaultody Callback basics\r\n\r\nVaultody Callbacks follow certain basics and the same standard that applies to all callback subscriptions.\r\n\r\n- Callback requests sent from Vaultody are **always** POST;\r\n- All Vaultody headers must by default incorporate the JSON content type **application/json**;\r\n- All Vaultody Callbacks incorporate the use of a Callback URL, without exception.\r\n- The attribute `x-signature` is a custom for Vaultody parameter, as indicated with the `x-` in the beginning;\r\n- The structure of the Callback is always the same, no matter the subscription or type of event.\r\n\r\n\r\n### Idempotency and `idempotentKey`\r\n\r\nIdempotency represents a process in computing and REST that a server uses to recognize subsequent retries of the same request where the returned result always remains the same. It is a security mechanism for retrying requests without the risk of performing the same operation more than once.\r\n\r\nSuch risks usually occur when an API call is for some reason disrupted during processing (e.g. network connection error) and a response is not returned. In such cases, the API call would be retried. By including an **`idempotencyKey`** in the initial request, there is a guarantee that the specific action won’t be done more than once.\r\n\r\nThe `idempotencyKey` is generated only on the server-end through the use of Vaultody Callbacks. It is added to the Callback request and is unique per initial callback request. `idempotencyKey` values are generated randomly. \r\n\r\nAll original requests containing an `idempotencyKey`, along with their body and response status code (both success and error), are saved by the system. After that, any subsequent requests containing the same `idempotencyKey` will automatically return the same result. \r\n\r\n\r\n## Setting up callbacks\r\n\r\nCallbacks combine certain elements and steps needed to create a correct reaction and on-time notification.\r\n\r\nTheir way of working requires the customer to first set up their Vault, and later on, whenever the subscription event occurs, the Vaultody will notify the customer. All steps are taken through the Vaultody Dashboard \r\n\r\n1. **Customer sets up Callback** \r\n\r\nIn the developers tab of the dashboard, you will see a Webhooks menu where you can add certain endpoints for which you would like to be notified. \r\n\r\n2. **Customer subscribes for an event**\r\n\r\nOnce you open the Add Endpoints module, you should select 4 main components. \r\nEndpoint URL where all notifications will be forwarded. \r\nSigned Secret key\r\nSelected Vaults that you would like to monitor.\r\nSelect the events for which you want to be notified. \r\n\r\n3. **Vaultody sends the Callback as a request**\r\n\r\nVaultody's responsibility to the customer is to notify them according to their subscription for that particular event or events **only when it/they occur**. Whenever the event happens, Vaultody sends a request back to the customer that includes the data on the event, as requested by the customer. This is essentially the “callback” itself. If the callback is not confirmed by the customer side with a “200 OK” response, the system will follow a specific retry strategy.\r\n\r\nIt is also important to clarify that subscribing to an event and setting a callback for it **does not** necessarily mean that the callback will occur soon or even at all. We do everything possible to make sure that callbacks have no delays, errors, or issues, and are received as events occur. \r\n\r\nStill, not receiving a callback for a subscribed event for a long time could be due to many reasons. There may be events that need to take days, weeks, or months to occur even just once, and some that may encounter problems, errors, and never happen at all.\r\n\r\n### Callback Retries\r\n\r\nWhen the callback request is sent from Vaultody, it expects a response from the customer side as well. \r\n\r\nUntil a status code of “200 OK Request has been successful” is received, Vaultody will keep retrying the request. There will be three retries in total, distributed at certain intervals.\r\n\r\n - Vaultody will send the requested callback when it’s time and a customer response is expected in the first 5 seconds;\r\n- If a response isn’t received during that time frame the system is prepared to send **in total 3** retries of the callback;\r\n- The first callback retry will be sent after 30 minutes.\r\n- After that, each following callback will take twice as long to be sent compared to the previous one. This is done with the purpose of extending the time during which the customer is going to receive the notification and its retries and providing an opportunity for the customer to send a “200 OK” response;\r\n- Additionally, there’s an included **“random value”** into the algorithm as a factor of **”0.2”**, which creates small but important fluctuations in the time frames between callback retries. This ensures that when large volumes of callbacks are sent, they are not sent in bulk due to having the same time frames, which could otherwise lead to crashes and server issues.\r\n\r\n{note}Time frames in the system are measured in seconds, e.g. first callback retry will be send after 30 min = 1800 sec.{/note}\r\n\r\n\r\n## Callback Security\r\n\r\nVaultody has incorporated a security layer to keep callbacks from being intercepted, duplicated and to make sure customers are receiving their callbacks only from Vaultody.\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\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." } ], "paths": { "/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses": { "post": { "tags": [ "Generating" ], "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, etc.", "example": "bitcoin", "enum": [ "bitcoin", "ethereum", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "nile", "sepolia" ] }, "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": "walletId", "required": true, "schema": { "type": "string", "description": "Represents the unique ID of the specific Wallet.", "example": "60c9d9921c38030006675ff6" }, "description": "Represents the unique ID of the specific Wallet.", "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": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GenerateDepositAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GenerateDepositAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GenerateDepositAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/transaction-requests": { "post": { "tags": [ "Transactions" ], "operationId": "Create Coins Transaction Request from Vault", "summary": "Create Coins Transaction Request from Vault", "description": "Through this endpoint users can create a new transaction request from the entire Wallet instead from just a specific address. This endpoint can generate transactions from multiple to multiple addresses.\r\n\r\n{warning}This is available **only** for UTXO-based protocols such as Bitcoin, Bitcoin Cash, Litecoin, etc. It **is not** available for Account-based protocols like Ethereum.{/warning}", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Bitcoin Cash, Litecoin etc.", "example": "bitcoin", "enum": [ "bitcoin" ] }, "description": "Represents the specific blockchain protocol name, e.g. Bitcoin, Bitcoin Cash, Litecoin 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 \"testnet\", is test network.", "example": "testnet", "default": "testnet", "enum": [ "mainnet", "testnet" ] }, "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 \"testnet\", is test network.", "example": "testnet" }, { "in": "path", "name": "walletId", "required": true, "schema": { "type": "string", "description": "Represents the sender's specific and unique Wallet ID of the sender.", "example": "609e221675d04500068718dc" }, "description": "Represents the sender's specific and unique Wallet ID of the sender.", "example": "609e221675d04500068718dc" }, { "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/CreateCoinsTransactionRequestFromVaultRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromVaultR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromVaultE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromVaultE401" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromVaultE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromVaultE409" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{address}/transaction-requests": { "post": { "tags": [ "Transactions" ], "operationId": "Create Coins Transaction Request from Address", "summary": "Create Coins Transaction Request from Address", "description": "Through this endpoint users can create a new single transaction request from one address to another.", "x-is-list": false, "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Defines the specific source address for the transaction.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "description": "Defines the specific source address for the transaction.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Binance Smart Chain etc.", "example": "ethereum", "enum": [ "ethereum", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Binance Smart Chain etc.", "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\" is test network.", "example": "mainnet", "enum": [ "mainnet", "testnet", "sepolia" ] }, "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\" is test network.", "example": "mainnet" }, { "in": "path", "name": "walletId", "required": true, "schema": { "type": "string", "description": "Represents the sender's specific and unique Wallet ID of the sender.", "example": "629df9dbae857c00073de9c8" }, "description": "Represents the sender's specific and unique Wallet 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/CreateCoinsTransactionRequestFromAddressRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromAddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromAddressE401" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionRequestFromAddressE409" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{address}/all-transaction-requests": { "post": { "tags": [ "Transactions" ], "operationId": "Create Coins Transaction From Address For Whole Amount", "summary": "Create Coins Transaction From Address For Whole Amount", "description": "Through this endpoint customers can create a new transaction from address for **coins** specifically, which will transfer over the entire available amount.", "x-is-list": false, "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Defines the source address.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "description": "Defines the source address.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Binance Smart Chain etc.", "example": "ethereum", "enum": [ "ethereum", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Binance Smart Chain etc.", "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 networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia" ] }, "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": "walletId", "required": true, "schema": { "type": "string", "description": "Represents the sender's specific and unique Wallet ID of the sender.", "example": "629df9dbae857c00073de9c8" }, "description": "Represents the sender's specific and unique Wallet 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/CreateCoinsTransactionFromAddressForWholeAmountRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCoinsTransactionFromAddressForWholeAmountR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionFromAddressForWholeAmountE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionFromAddressForWholeAmountE401" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionFromAddressForWholeAmountE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateCoinsTransactionFromAddressForWholeAmountE409" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/vaults": { "get": { "tags": [ "Informative" ], "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": "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": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListVaultsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{senderAddress}/token-transaction-requests": { "post": { "tags": [ "Transactions" ], "operationId": "Create Fungible Tokens Transaction Request From Address", "summary": "Create Fungible Tokens Transaction Request From Address", "description": "Through this endpoint users can make a single token transaction.\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, e.g. Ethereum, Binance-smart-chain, etc.", "example": "ethereum", "enum": [ "ethereum", "binance-smart-chain" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Binance-smart-chain, etc.", "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 networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia" ] }, "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": "senderAddress", "required": true, "schema": { "type": "string", "description": "Defines the specific source address for the transaction.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, "description": "Defines the specific source address for the transaction.", "example": "0x0902a667d6a3f287835e0a4593cae4167384abc6" }, { "in": "path", "name": "walletId", "required": true, "schema": { "type": "string", "description": "Defines the unique ID of the Wallet.", "example": "609e221675d04500068718dc" }, "description": "Defines the unique ID of the Wallet.", "example": "609e221675d04500068718dc" }, { "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/CreateFungibleTokensTransactionRequestFromAddressRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFungibleTokensTransactionRequestFromAddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateFungibleTokensTransactionRequestFromAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateFungibleTokensTransactionRequestFromAddressE401" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateFungibleTokensTransactionRequestFromAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateFungibleTokensTransactionRequestFromAddressE409" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/assets": { "get": { "tags": [ "Informative" ], "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": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByVaultE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/transactionRequests/{transactionRequestId}": { "get": { "tags": [ "Informative" ], "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": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionRequestDetailsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{address}/feeless-transaction-requests": { "post": { "tags": [ "Transactions" ], "operationId": "Create Single Transaction Request From Address Without Fee Priority", "summary": "Create Single Transaction Request From Address Without Fee Priority", "description": "Through this endpoint users can create a new single transaction request from one address to another. The difference between this endpoint and \"Create Coins Transaction Request from Address\" is that for Tron blockchain there is no Fee Priority that defines how fast a transaction can be mined.", "x-is-list": false, "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "description": "Defines the specific source address for the transaction.", "example": "TX8VXpdEoNNrKeEuNTfbEXfa9eZivcyUwD" }, "description": "Defines the specific source address for the transaction.", "example": "TX8VXpdEoNNrKeEuNTfbEXfa9eZivcyUwD" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Tron.", "example": "tron", "enum": [ "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Tron.", "example": "tron" }, { "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\" is test network.", "example": "nile", "enum": [ "mainnet", "nile" ] }, "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\" is test network.", "example": "nile" }, { "in": "path", "name": "walletId", "required": true, "schema": { "type": "string", "description": "Represents the sender's specific and unique Wallet ID of the sender.", "example": "62b9b5c3b97f4b0008092714" }, "description": "Represents the sender's specific and unique Wallet ID of the sender.", "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/CreateSingleTransactionRequestFromAddressWithoutFeePriorityRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSingleTransactionRequestFromAddressWithoutFeePriorityR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateSingleTransactionRequestFromAddressWithoutFeePriorityE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateSingleTransactionRequestFromAddressWithoutFeePriorityE401" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateSingleTransactionRequestFromAddressWithoutFeePriorityE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateSingleTransactionRequestFromAddressWithoutFeePriorityE409" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/wallets/{vaultId}/{blockchain}/addresses": { "get": { "tags": [ "Informative" ], "operationId": "List Addresses by Vault and Blockchain", "summary": "List Addresses by Vault and Blockchain", "description": "List Addresses by Vault ID and Blockchain", "x-is-list": true, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, 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": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAddressesByVaultAndBlockchainE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses/{senderAddress}/feeless-token-transaction-requests": { "post": { "tags": [ "Transactions" ], "operationId": "Create Fungible Token Transaction Request From Address Without Fee Priority", "summary": "Create Fungible Token Transaction Request From Address Without Fee Priority", "description": "Through this endpoint customers can make a single feeless token transaction on the Tron blockchain protocol. TRX transactions burn certain resources called Bandwidth and Energy. Each account has 1500 bandwidth free for use every 24 hours and more can be obtained by staking TRX. The unit price of Energy is 280 SUN and of bandwidth - 1000 SUN. If the resources are insufficient, TRX will be burned to pay for them.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Tron.", "example": "tron", "enum": [ "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Tron.", "example": "tron" }, { "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 \"nile\" is test network.", "example": "nile", "enum": [ "mainnet", "nile" ] }, "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 \"nile\" is test network.", "example": "nile" }, { "in": "path", "name": "senderAddress", "required": true, "schema": { "type": "string", "description": "Defines the specific source address for the transaction.", "example": "TX8VXpdEoNNrKeEuNTfbEXfa9eZivcyUwD" }, "description": "Defines the specific source address for the transaction.", "example": "TX8VXpdEoNNrKeEuNTfbEXfa9eZivcyUwD" }, { "in": "path", "name": "walletId", "required": true, "schema": { "type": "string", "description": "Defines the unique ID of the Wallet.", "example": "62b9b5c3b97f4b0008092714" }, "description": "Defines the unique ID of the Wallet.", "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/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityRB" } } } }, "responses": { "201": { "description": "The resource has been successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityE401" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "409", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/CreateFungibleTokenTransactionRequestFromAddressWithoutFeePriorityE409" } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/blockchain-tools/{blockchain}/{network}/addresses/validate": { "post": { "tags": [ "Utils" ], "operationId": "Validate Address", "summary": "Validate Address", "description": "This endpoint checks user public addresses whether they are valid or not.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin", "enum": [ "bitcoin", "ethereum", "binance-smart-chain", "tron" ] }, "description": "Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.", "example": "bitcoin" }, { "in": "path", "name": "network", "required": true, "schema": { "type": "string", "description": "Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"sepolia\" are test networks.", "example": "testnet", "enum": [ "mainnet", "testnet", "sepolia", "nile" ] }, "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": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ValidateAddressE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/{blockchain}/transactions/{transactionId}": { "get": { "tags": [ "Informative" ], "operationId": "Get Transaction Details", "summary": "Get Transaction Details", "description": "Through this endpoint customers can obtain details about a mined transaction.", "x-is-list": false, "parameters": [ { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "example": "bitcoin" }, "example": "bitcoin" }, { "in": "path", "name": "transactionId", "required": true, "schema": { "type": "string", "example": "6597ecb67af4772161af22a5" }, "example": "6597ecb67af4772161af22a5" }, { "in": "path", "name": "vaultId", "required": true, "schema": { "type": "string", "example": "6565f9a13f8dcd000760d33a" }, "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": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/GetTransactionDetailsE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "404": { "description": "The specified resource has not been found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/transactions": { "get": { "tags": [ "Informative" ], "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 Vault ID", "example": "6565f9a13f8dcd000760d33a" }, "description": "The 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": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultE401" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListTransactionsByVaultE403" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } }, "/vaults/{vaultId}/{blockchain}/addresses/{address}/assets": { "get": { "tags": [ "Informative" ], "operationId": "List Assets by Address", "summary": "List Assets by Address", "description": "This endpoint will list all assets for this address on this Blockchain, the network is based on the Vault.", "x-is-list": false, "parameters": [ { "in": "path", "name": "address", "required": true, "schema": { "type": "string", "example": "TRQMiKnp2WcJCVbeLwKAAvQAYizsYxpA1P" }, "example": "TRQMiKnp2WcJCVbeLwKAAvQAYizsYxpA1P" }, { "in": "path", "name": "blockchain", "required": true, "schema": { "type": "string", "description": "Represents the specific blockchain protocol name, e.g. Tron, Ethereum, Bitcoin, etc.", "example": "tron" }, "description": "Represents the specific blockchain protocol name, e.g. Tron, Ethereum, Bitcoin, etc.", "example": "tron" }, { "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": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAssetsByAddressR" } } } }, "400": { "description": "400", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ListAssetsByAddressE400" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "401": { "description": "401", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InsufficientCredits" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "403": { "description": "403", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/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": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/ResourceNotFound" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "409": { "description": "The data provided seems to be invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidData" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "415": { "description": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnsupportedMediaType" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "422": { "description": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/InvalidRequestBodyStructure" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "429": { "description": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/RequestLimitReached" } }, "required": [ "apiVersion", "requestId", "error" ] } } } }, "500": { "description": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiVersion": { "type": "string", "description": "Specifies the version of the API that incorporates this endpoint.", "example": "2023-04-20" }, "requestId": { "type": "string", "description": "Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.", "example": "601c1710034ed6d407996b30" }, "context": { "type": "string", "description": "In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.", "example": "yourExampleString" }, "error": { "$ref": "#/components/schemas/UnexpectedServerError" } }, "required": [ "apiVersion", "requestId", "error" ] } } } } } } } }, "x-tagGroups": [ { "name": "General Information", "tags": [ "Getting Started", "Authentication", "Data Flow Limiting", "Standards Conventions and Versioning", "Webhooks", "Postman Collection" ] }, { "name": "Wallet as a Service", "tags": [ "Generating", "Transactions", "Informative", "Utils" ] } ] }