Merchants
List Merchant Accounts
Retrieve a paginated list of merchant fiat payment accounts with their activation status, current balances, and monthly transaction limits.
GET
/
v2
/
merchant
/
accounts
List Merchant Accounts
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/accounts \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/accounts"
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/merchant/accounts', 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/merchant/accounts")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"merchantId": 123,
"fiat": "<string>",
"balance": "<string>",
"status": 123,
"paymentId": 123,
"paymentMethodName": "<string>",
"monthBuyLimit": "<string>",
"monthBuyUsed": "<string>",
"monthSellLimit": "<string>",
"monthSellUsed": "<string>",
"failReason": "<string>",
"createTime": "<string>",
"updateTime": "<string>"
}
]
}
}Use this endpoint to inspect the fiat payment accounts associated with one or more merchants. Each account record shows the currency, current balance, channel details, and monthly buy and sell limits with usage figures. You can filter by merchant ID, currency, or activation status to narrow results.
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/merchant/accounts
Query Parameters
integer
Filter by the merchant’s unique ID (MID).
string
Filter by merchant name.
string
Filter by merchant email address.
string
Filter by fiat currency code, e.g.
MXN, ARS, BRL.integer
Filter by account activation status:
1— pending2— active3— failed4— incomplete
integer
Page number to retrieve (1-based). Defaults to
1.integer
Number of records per page. Default is
10, maximum is 1000.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
number
Current page number returned.
number
Number of records on this page.
number
Total number of accounts matching the query.
array
Show record item fields
Show record item fields
number
Unique merchant identifier.
string
Fiat currency of this account.
string
Current balance in the fiat currency.
number
Account status:
0 = initialized, 1 = pending, 2 = active, 3 = failed, 4 = incomplete. Closed or disabled channels are also reported as 1. Records are listed per channel configuration, so a channel that is still pending or incomplete may not be listed yet.number
ID of the payment channel configuration.
string
Human-readable name of the payment method (e.g.,
Automated Bank Transfer(Mexico)).string
Monthly buy (on-ramp) fiat limit for this account.
string
Fiat amount used against the monthly buy limit this month.
string
Monthly sell (off-ramp) fiat limit for this account.
string
Fiat amount used against the monthly sell limit this month.
string
Reason for activation failure, if applicable.
string
Unix timestamp (milliseconds) when the account was created.
string
Unix timestamp (milliseconds) when the account was last updated.
Example
cURL
curl -G https://api.velafi.com/v2/merchant/accounts \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=100001" \
--data-urlencode "status=2" \
--data-urlencode "pageSize=10"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"currentPage": 1,
"size": 10,
"total": 2,
"record": [
{
"merchantId": 1,
"fiat": "MXN",
"balance": "100.00",
"status": 2,
"paymentId": 105,
"paymentMethodName": "Automated Bank Transfer(Mexico)",
"monthBuyLimit": "50000",
"monthBuyUsed": "2000.00",
"monthSellLimit": "50000",
"monthSellUsed": "0",
"failReason": "",
"createTime": "1737452292000",
"updateTime": "1737452344000"
}
]
}
}
Was this page helpful?
⌘I
List Merchant Accounts
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/accounts \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/accounts"
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/merchant/accounts', 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/merchant/accounts")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"merchantId": 123,
"fiat": "<string>",
"balance": "<string>",
"status": 123,
"paymentId": 123,
"paymentMethodName": "<string>",
"monthBuyLimit": "<string>",
"monthBuyUsed": "<string>",
"monthSellLimit": "<string>",
"monthSellUsed": "<string>",
"failReason": "<string>",
"createTime": "<string>",
"updateTime": "<string>"
}
]
}
}