Crypto Wallet
List Crypto Withdrawals
List crypto withdrawals from a VelaFi merchant wallet, newest first, filtered by token, clientId, and time range.
GET
/
v2
/
assets
/
withdrawalOrders
List Crypto Withdrawals
curl --request GET \
--url https://api-test.velafi.com/v2/assets/withdrawalOrders \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/withdrawalOrders"
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/withdrawalOrders', 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/withdrawalOrders")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"orderId": 123,
"merchantId": 123,
"time": 123,
"crypto": "<string>",
"cryptoName": "<string>",
"address": "<string>",
"addressTag": "<string>",
"cryptoAmount": "<string>",
"fee": "<string>",
"feeCrypto": "<string>",
"arriveCryptoAmount": "<string>",
"status": 123,
"txId": "<string>",
"txIdUrl": "<string>",
"remark": "<string>"
}
]
}Use this endpoint to track crypto withdrawals from a merchant wallet to external addresses, including those created with Create Crypto Withdrawal. To be notified when a withdrawal reaches its final status, subscribe to Crypto Withdrawal Event. You can also poll this endpoint by
clientId until status is 6, 7 or 9, for example to reconcile withdrawals whose webhook you missed. Stablecoin payment refunds in this list don’t trigger the webhook. The list can also include other withdrawal-type records, such as mass payouts. Withdrawals to a VelaFi wallet address are booked as internal transfers and appear in Crypto Transfer History instead. Results are sorted newest first, and a single call returns up to pageSize records. To find one withdrawal, filter by clientId.
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/withdrawalOrders
Query Parameters
number
required
Merchant ID.
string
Filter by token symbol, for example
USDT.string
Filter by the
clientId you supplied when creating the withdrawal.number
Only return withdrawals created at or after this time (Unix timestamp in milliseconds).
number
Only return withdrawals 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
Withdrawal record ID. It matches the
orderId returned by Create Crypto Withdrawal.number
Merchant whose wallet was debited.
number
Time the withdrawal record was created (Unix timestamp in milliseconds).
string
Token symbol.
string
Token name. Currently the same as
crypto.string
Destination address.
string
Destination memo or tag, if any.
string
Withdrawal amount.
string
Network fee.
string
Token the fee is denominated in. This is always the same as
crypto.string
cryptoAmount minus fee.number
Withdrawal status:
5— in progress, including withdrawals held for VelaFi’s internal audit6— successful7— failed9— cancelled0— any other state, for example while the withdrawal is waiting for sub-account approval or is held for a risk information request (RFI)
string
On-chain transaction hash, once available.
string
Block-explorer link for the transaction.
string
The
remark you supplied when creating the withdrawal.Example
cURL
curl -G https://api.velafi.com/v2/assets/withdrawalOrders \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=151209" \
--data-urlencode "clientId=withdraw-0001"
⌘I
List Crypto Withdrawals
curl --request GET \
--url https://api-test.velafi.com/v2/assets/withdrawalOrders \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/withdrawalOrders"
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/withdrawalOrders', 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/withdrawalOrders")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"orderId": 123,
"merchantId": 123,
"time": 123,
"crypto": "<string>",
"cryptoName": "<string>",
"address": "<string>",
"addressTag": "<string>",
"cryptoAmount": "<string>",
"fee": "<string>",
"feeCrypto": "<string>",
"arriveCryptoAmount": "<string>",
"status": 123,
"txId": "<string>",
"txIdUrl": "<string>",
"remark": "<string>"
}
]
}