Generate Deposit Address
Through this endpoint customers can generate a new Receiving/Deposit Addresses into their Wallet.
Path Parameters
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
Example : bitcoinPossible Values : bitcoin bitcoin-cash litecoin dogecoin dash ethereum ethereum-classic xrp zcash binance-smart-chain tron -
Requirednetwork string
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", "goerli" are test networks.
Example : testnetPossible Values : mainnet testnet mordor nile goerli -
RequiredwalletId string
Represents the unique ID of the specific Wallet.
Example : 60c9d9921c38030006675ff6
Query parameters
-
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString
Request body schema application/json
-
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requireddata object
-
Requireditem object
-
Requiredlabel string
Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".
Example : yourLabelStringHere
-
-
Response schema
Content-Type: application/json
The resource has been successfully created.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requireddata object
-
Requireditem object
-
Requiredaddress string
Specifies the specific address's unique string value.
Example : 0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036 -
RequiredcreatedTimestamp integer
Defines the specific UNIX time when the deposit address was created.
Example : 1624028267 -
Requiredlabel string
Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".
Example : yourLabelStringHere
-
-
Content-Type: application/json
400
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : uri_not_found -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : limit_greater_than_allowed -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_pagination -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
401
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : missing_api_key -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_api_key -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
insufficient_credits
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : insufficient_credits -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
403
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : banned_ip_address -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : endpoint_not_allowed_for_plan -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : endpoint_not_allowed_for_api_key -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : feature_mainnets_not_allowed_for_plan -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : wallet_as_a_service_deposit_addresses_limit_reached -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : wallet_as_a_service_provided_network_is_not_suitable_for_this_wallet_type -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
The specified resource has not been found.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
resource_not_found
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : resource_not_found -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : Resource not found -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
The data provided seems to be invalid.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
invalid_data
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_data -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
unsupported_media_type
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : unsupported_media_type -
Requiredmessage string
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'. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
Your request body for POST requests must have a structure of { data: { item: [...properties] } }
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
invalid_request_body_structure
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_request_body_structure -
Requiredmessage string
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] } } -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
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.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
request_limit_reached
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : request_limit_reached -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
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.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2023-04-25 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
unexpected_server_error
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : unexpected_server_error -
Requiredmessage string
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. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-