Crypto Wallet
Add a Whitelist Address
Add a destination address to your crypto withdrawal whitelist. API withdrawals can only go to whitelisted addresses.
POST
/
v2
/
user
/
whitelistAddress
Add a Whitelist Address
curl --request POST \
--url https://api-test.velafi.com/v2/user/whitelistAddress \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"crypto": "<string>",
"chainType": "<string>",
"address": "<string>",
"addressTag": "<string>",
"remark": "<string>"
}
'import requests
url = "https://api-test.velafi.com/v2/user/whitelistAddress"
payload = {
"crypto": "<string>",
"chainType": "<string>",
"address": "<string>",
"addressTag": "<string>",
"remark": "<string>"
}
headers = {
"X-BH-TOKEN": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-BH-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
crypto: '<string>',
chainType: '<string>',
address: '<string>',
addressTag: '<string>',
remark: '<string>'
})
};
fetch('https://api-test.velafi.com/v2/user/whitelistAddress', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api-test.velafi.com/v2/user/whitelistAddress")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"crypto\": \"<string>\",\n \"chainType\": \"<string>\",\n \"address\": \"<string>\",\n \"addressTag\": \"<string>\",\n \"remark\": \"<string>\"\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"addressId": 123,
"crypto": "<string>",
"chainType": "<string>",
"address": "<string>",
"addressTag": "<string>",
"remark": "<string>"
}
}API crypto withdrawals can only go to addresses on your withdrawal whitelist. Use this endpoint to add an address for a specific token and network. Whitelist entries belong to your API user, so they apply to every merchant under it.
Adding an address that is already on your whitelist for the same
All requests must include the
X-BH-TOKEN header with an access token and Content-Type: application/json. See Authentication.Endpoint
POST https://api.velafi.com/v2/user/whitelistAddress
Request Parameters
string
required
Token symbol, for example
USDT. It must be a token currently enabled on VelaFi.string
required
Network name, for example
TRC20. Use a chainType returned by Get Withdrawal Quota.string
required
Destination address. It must be a valid address for the network. Otherwise the request is rejected.
string
Memo or tag, for networks that use one. Withdrawals to this entry must use the same
addressTag.string
Your label for this address.
crypto, chainType, address and addressTag is rejected as a duplicate.
Response Fields
number
200 indicates success.string
SUCCESS on success.object
Example
cURL
curl -X POST https://api.velafi.com/v2/user/whitelistAddress \
-H "X-BH-TOKEN: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"crypto": "USDT",
"chainType": "TRC20",
"address": "YOUR_DESTINATION_ADDRESS",
"remark": "Treasury wallet"
}'
⌘I
Add a Whitelist Address
curl --request POST \
--url https://api-test.velafi.com/v2/user/whitelistAddress \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"crypto": "<string>",
"chainType": "<string>",
"address": "<string>",
"addressTag": "<string>",
"remark": "<string>"
}
'import requests
url = "https://api-test.velafi.com/v2/user/whitelistAddress"
payload = {
"crypto": "<string>",
"chainType": "<string>",
"address": "<string>",
"addressTag": "<string>",
"remark": "<string>"
}
headers = {
"X-BH-TOKEN": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-BH-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
crypto: '<string>',
chainType: '<string>',
address: '<string>',
addressTag: '<string>',
remark: '<string>'
})
};
fetch('https://api-test.velafi.com/v2/user/whitelistAddress', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api-test.velafi.com/v2/user/whitelistAddress")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"crypto\": \"<string>\",\n \"chainType\": \"<string>\",\n \"address\": \"<string>\",\n \"addressTag\": \"<string>\",\n \"remark\": \"<string>\"\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"addressId": 123,
"crypto": "<string>",
"chainType": "<string>",
"address": "<string>",
"addressTag": "<string>",
"remark": "<string>"
}
}