Crypto Wallet
List Crypto Deposits
List on-chain crypto deposits into your VelaFi merchant wallets, newest first, filtered by token, transaction hash, merchant, and time range.
GET
/
v2
/
assets
/
depositOrders
List Crypto Deposits
curl --request GET \
--url https://api-test.velafi.com/v2/assets/depositOrders \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/depositOrders"
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/depositOrders', 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/depositOrders")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"orderId": 123,
"merchantId": 123,
"time": 123,
"crypto": "<string>",
"cryptoName": "<string>",
"cryptoAmount": "<string>",
"address": "<string>",
"addressTag": "<string>",
"fromAddress": "<string>",
"fromAddressTag": "<string>",
"status": 123,
"txId": "<string>",
"txIdUrl": "<string>"
}
]
}Use this endpoint to list crypto deposits received by your merchant wallets. Results are sorted newest first, and a single call returns up to
pageSize records. To look further back, narrow the window with startTime and endTime.
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/depositOrders
Query Parameters
number
Filter by merchant ID.
string
Filter by token symbol, for example
USDT.string
Filter by on-chain transaction hash.
number
Only return deposits created at or after this time (Unix timestamp in milliseconds).
number
Only return deposits created at or before this time (Unix timestamp in milliseconds).
number
default:"10"
Maximum number of records to return, from
1 to 1000. Defaults to 10.Response Fields
number
200 indicates success.string
SUCCESS on success.array
Show data item fields
Show data item fields
number
Deposit record ID.
number
Merchant that received the deposit.
number
Time the deposit record was created (Unix timestamp in milliseconds).
string
Token symbol.
string
Token name. Currently the same as
crypto.string
Deposited amount.
string
Currently returns the same value as
fromAddress (the sending address), not your VelaFi deposit address.string
Currently always an empty string.
string
Sending address.
string
Currently always an empty string.
number
Deposit status:
1— in progress2— successful3— failed or cancelled4— any other state
string
On-chain transaction hash.
string
Block-explorer link for the transaction.
Example
cURL
curl -G https://api.velafi.com/v2/assets/depositOrders \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=151209" \
--data-urlencode "crypto=USDT" \
--data-urlencode "pageSize=50"
⌘I
List Crypto Deposits
curl --request GET \
--url https://api-test.velafi.com/v2/assets/depositOrders \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/depositOrders"
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/depositOrders', 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/depositOrders")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"orderId": 123,
"merchantId": 123,
"time": 123,
"crypto": "<string>",
"cryptoName": "<string>",
"cryptoAmount": "<string>",
"address": "<string>",
"addressTag": "<string>",
"fromAddress": "<string>",
"fromAddressTag": "<string>",
"status": 123,
"txId": "<string>",
"txIdUrl": "<string>"
}
]
}