Merchants
Get Crypto Deposit Address
Retrieve the on-chain deposit address for a specific token and blockchain network for a merchant wallet, including confirmation requirements.
GET
/
v2
/
assets
/
depositAddress
Get Crypto Deposit Address
curl --request GET \
--url https://api-test.velafi.com/v2/assets/depositAddress \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/depositAddress"
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/depositAddress', 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/depositAddress")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"allowDeposit": true,
"address": "<string>",
"addressExt": "<string>",
"minQuantity": "<string>",
"needAddressTag": true,
"requiredConfirmNum": 123,
"canWithdrawConfirmNum": 123,
"tokenType": "<string>"
}
}Use this endpoint to retrieve the on-chain deposit address for a specific cryptocurrency and network. You must provide both a
tokenId and a chainType from the supported combinations below. The response includes the deposit address, any required address tag (e.g., for XRP or EOS), minimum deposit amount, and confirmation requirements.
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/depositAddress
Query Parameters
string
required
Token symbol to deposit. Supported values:
USDT, USDC, BTC, COPM, BRL1, MXNB, MMXN.string
required
Blockchain network identifier. Must be a valid pairing for the selected
tokenId. See the supported combinations table below.integer
required
The ID of the merchant whose deposit address to retrieve.
Supported Token / Network Combinations
| tokenId | chainType | Network |
|---|---|---|
USDT | TRC20 | Tron |
USDT | ERC20 | Ethereum |
USDT | BEP20 | BNB Smart Chain |
USDT | POL | Polygon |
USDT | SPL20 | Solana Mainnet |
USDC | ERC20 | Ethereum |
USDC | POL | Polygon |
USDC | SPL20 | Solana Mainnet |
BTC | BTC | Bitcoin |
COPM | POL | Polygon (POS) |
BRL1 | POL | Polygon (POS) |
MXNB | Arbitrum | Arbitrum Network |
MMXN | ERC20 | Ethereum (ERC20) |
MMXN | TRC20 | TRON (TRC20) |
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 deposits are currently enabled for this address.
string
The on-chain deposit address.
string
Address tag or memo (required for some tokens). Empty string if not needed.
string
Minimum deposit amount for this token.
boolean
Whether an address tag must be included with the deposit transaction.
number
Number of on-chain confirmations required before the deposit is credited.
number
Number of on-chain confirmations required before the deposited funds become withdrawable.
string
Internal token type identifier.
Example
cURL
curl -G https://api.velafi.com/v2/assets/depositAddress \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "tokenId=USDT" \
--data-urlencode "chainType=TRC20" \
--data-urlencode "merchantId=12345"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"allowDeposit": true,
"address": "YOUR_DEPOSIT_ADDRESS",
"addressExt": "",
"minQuantity": "5",
"needAddressTag": false,
"requiredConfirmNum": 12,
"canWithdrawConfirmNum": 20,
"tokenType": "TRX_TOKEN"
}
}
Always check
allowDeposit before displaying the address to users. If allowDeposit is false, funds sent to this address may not be credited. Contact VelaFi support if the flag remains false unexpectedly.Was this page helpful?
⌘I
Get Crypto Deposit Address
curl --request GET \
--url https://api-test.velafi.com/v2/assets/depositAddress \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/depositAddress"
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/depositAddress', 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/depositAddress")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"allowDeposit": true,
"address": "<string>",
"addressExt": "<string>",
"minQuantity": "<string>",
"needAddressTag": true,
"requiredConfirmNum": 123,
"canWithdrawConfirmNum": 123,
"tokenType": "<string>"
}
}