Appearance
Get a crypto deposit address​
GET
/v1/wallet/crypto/{currency}/deposit/address
Requires DEPOSITS_READ, granted by TREASURY_READ or TREASURY_WRITE (bundles)
Returns the deposit address for a currency on one network for the account the request acts on (your primary account, or the sub-account selected with X-VALR-SUB-ACCOUNT-ID), creating one if the account doesn't have one yet. To get the address of one of your business's payments accounts instead, send accountType and destinationCurrency together; a key restricted to sub-accounts can't do this.
Parameters​
Path Parameters
currency*
Crypto currency to deposit, e.g. USDT.
Type
Requiredstring
Example
"USDT"Query Parameters
networkType
Network to deposit on, e.g. Ethereum. Defaults to the currency's default network.
Type
string
Example
"Ethereum"accountType
Payments account to get the address for, instead of the account the request acts on: COLLECTIONS, FUNDING or PAYOUTS (case-insensitive). Only takes effect together with destinationCurrency; if you send just one of the two, both are ignored.
Type
string
Valid values
"COLLECTIONS""FUNDING""PAYOUTS"Example
"FUNDING"destinationCurrency
Currency the payments account chosen with accountType is set up for, e.g. ZAR for a funding account whose deposits are converted to rand. Only takes effect together with accountType.
Type
string
Example
"ZAR"Responses​
OK
application/json
JSON
{
"currency": "USDT",
"address": "0x5b3f9a1c2e7d48a6b0c4e9f1a2d3b4c5e6f70812",
"networkType": "Ethereum"
}
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | -11INVALID_REQUEST | The currency or destinationCurrency isn't recognised, or accountType is blank or isn't COLLECTIONS, FUNDING or PAYOUTS. |
| 400 | -112CURRENCY_NOT_SUPPORTED | networkType wasn't sent and the currency can't be deposited on a blockchain, for example a fiat currency. |
| 400 | -15721SCOPED_DEPOSIT_ACCOUNT_CURRENCY_MISMATCH | Your business has no account of the requested accountType set up for destinationCurrency. |
| 400 | -13105RECEIVE_ADDRESS_NOT_SUPPORTED_FOR_CURRENCY_NETWORK_TYPE | The account has no address for this currency and network yet, and deposits on this network are disabled or not supported for this currency. |
| 403 | -13104RECEIVE_ADDRESS_NOT_SUPPORTED_IN_REGION | The account has no address for this currency and network yet, and crypto deposits are restricted for your business, so a new one can't be created. |
| 500 | -30COULD_NOT_GET_RECEIVE_ADDRESS | A new deposit address couldn't be created. Try again later. |
Plus the errors common to all signed endpoints.