Merchants
Get Crypto Balance
Retrieve cryptocurrency wallet balances for a specific merchant or get aggregated totals across all merchants linked to your API key.
GET
/
v2
/
assets
/
account
/
assets
Get Crypto Balance
curl --request GET \
--url https://api-test.velafi.com/v2/assets/account/assets \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/account/assets"
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/account/assets', 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/account/assets")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"canDeposit": true,
"balances": [
{
"asset": "<string>",
"assetId": "<string>",
"assetName": "<string>",
"total": "<string>",
"free": "<string>",
"locked": "<string>"
}
]
}
}Use this endpoint to check the crypto asset balances held in a merchant’s custody wallet. Pass a specific
merchantId to scope results to a single merchant, or pass 0 to receive aggregated totals across all merchants linked to your API key. Each asset entry shows the total balance, the free (available) portion, and any locked amount (reserved for pending orders).
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/account/assets
Query Parameters
integer
required
The ID of the merchant to query. Pass
0 to aggregate balances across all merchants linked to this API key.Response Fields
number
HTTP-style response code.
200 indicates success.string
Human-readable status message, e.g.
SUCCESS.object
Show data fields
Show data fields
boolean
Whether the account is currently able to receive crypto deposits.
Examples
- Specific Merchant
- Aggregated (All Merchants)
cURL
curl -G https://api.velafi.com/v2/assets/account/assets \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=12345"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"canDeposit": true,
"balances": [
{
"asset": "USDT",
"assetId": "USDT",
"assetName": "USDT",
"total": "1000",
"free": "800",
"locked": "200"
},
{
"asset": "BTC",
"assetId": "BTC",
"assetName": "BTC",
"total": "0.5",
"free": "0.3",
"locked": "0.2"
}
]
}
}
cURL
curl -G https://api.velafi.com/v2/assets/account/assets \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=0"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"canDeposit": true,
"balances": [
{
"asset": "USDT",
"assetId": "USDT",
"assetName": "USDT",
"total": "5000",
"free": "4000",
"locked": "1000"
},
{
"asset": "BTC",
"assetId": "BTC",
"assetName": "BTC",
"total": "2",
"free": "1.5",
"locked": "0.5"
}
]
}
}
When
merchantId is 0, the API sums balances across all merchants bound to the same account. Use this to get a portfolio-level view without looping through individual merchant IDs.Was this page helpful?
⌘I
Get Crypto Balance
curl --request GET \
--url https://api-test.velafi.com/v2/assets/account/assets \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/account/assets"
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/account/assets', 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/account/assets")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"canDeposit": true,
"balances": [
{
"asset": "<string>",
"assetId": "<string>",
"assetName": "<string>",
"total": "<string>",
"free": "<string>",
"locked": "<string>"
}
]
}
}