Crypto Wallet
Get Withdrawal Quota
Look up the minimum withdrawal amount, the supported networks, and the configured network fee for a crypto token before you create a withdrawal.
GET
/
v2
/
assets
/
withdrawQuota
Get Withdrawal Quota
curl --request GET \
--url https://api-test.velafi.com/v2/assets/withdrawQuota \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/withdrawQuota"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/assets/withdrawQuota', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/assets/withdrawQuota")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"crypto": "<string>",
"minCryptoAmount": "<string>",
"chainTypeInfo": [
{
"chainType": "<string>",
"allowWithdraw": true,
"fee": "<string>",
"feeCrypto": "<string>"
}
]
}
}Call this endpoint before you create a crypto withdrawal. For a given token it returns the minimum withdrawal amount and, for each network, its on-chain withdrawal flag and its configured network fee. Use the
chainType values it returns when you add whitelist addresses and create withdrawals.
All requests must include the
X-BH-TOKEN header with a business token from GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/assets/withdrawQuota
Query Parameters
string
required
Token symbol, for example
USDT. If the token is not found, the request fails with Token not found.string
Network name, for example
TRC20. When supplied, only that network is returned. If the token has no such network, the request fails with Chain type not found.Response Fields
number
200 indicates success.string
SUCCESS on success.object
Show data fields
Show data fields
string
Token symbol.
string
Minimum amount for a single withdrawal of this token to an external address, on any network.
0 means no minimum is configured.array
One entry per network.
Show chainTypeInfo item fields
Show chainTypeInfo item fields
string
Network name. Pass this value exactly as
chainType to the whitelist and withdrawal endpoints.boolean
On-chain withdrawal flag for this network. When
false, withdrawals to external addresses on this network are rejected. true does not guarantee that a withdrawal will be accepted.string
Network fee configured for this network. Withdrawals to VelaFi wallet addresses carry no network fee.
string
Token the fee is denominated in. This is always the same as
crypto.Example
cURL
curl -G https://api.velafi.com/v2/assets/withdrawQuota \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "crypto=USDT" \
--data-urlencode "chainType=TRC20"
⌘I
Get Withdrawal Quota
curl --request GET \
--url https://api-test.velafi.com/v2/assets/withdrawQuota \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/withdrawQuota"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/assets/withdrawQuota', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/assets/withdrawQuota")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"crypto": "<string>",
"minCryptoAmount": "<string>",
"chainTypeInfo": [
{
"chainType": "<string>",
"allowWithdraw": true,
"fee": "<string>",
"feeCrypto": "<string>"
}
]
}
}