商户
获取商户列表
分页获取商户列表，包括其 KYC 验证状态、每日和每月交易限额以及当前使用量。
GET
/
v2
/
merchants
获取商户列表
curl --request GET \
--url https://api-test.velafi.com/v2/merchants \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchants"
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/merchants', 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/merchants")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"merchantId": 123,
"country": "<string>",
"merchantName": "<string>",
"email": "<string>",
"merchantType": 123,
"status": 123,
"rejectReason": "<string>",
"upgradeMerchantLimitStatus": 123,
"upgradeMerchantLimitRejectReason": "<string>",
"dayFiatLimit": 123,
"dayFiatUsed": 123,
"monthFiatLimit": 123,
"monthFiatUsed": 123,
"monthCryptoLimit": 123,
"monthCryptoUsed": 123,
"remark": "<string>",
"createTime": "<string>",
"updateTime": "<string>"
}
]
}
}使用此接口查询在你的账户下注册的商户。你可以按名称、邮箱或验证状态进行筛选，并对结果进行分页。响应包含每个商户的 KYC 状态、每日和每月交易限额以及当前使用量 —— 便于监控合规额度余量。
所有请求都必须在
X-BH-TOKEN 请求头中携带通过 GET /v2/token/generate 获取的业务 token。接口地址
GET https://api.velafi.com/v2/merchants
查询参数
string
按商户名称筛选结果（支持部分匹配）。
string
按商户邮箱地址筛选结果。
integer
按 KYC/KYB 验证状态筛选：
-1— 所有状态1— 认证中2— 正常（默认）3— 认证失败4— 未完成
integer
要获取的页码（从 1 开始）。默认为
1。integer
每页记录数。默认为
10，最大为 1000。响应字段
number
HTTP 风格的响应码。
200 表示成功。string
可读的状态信息，例如
SUCCESS。object
显示 data 字段
显示 data 字段
number
返回的当前页码。
number
本页返回的记录数。
number
符合查询条件的商户总数。
array
显示 record 条目字段
显示 record 条目字段
number
商户的唯一标识符。
string
商户所在国家。
string
商户的显示名称。
string
商户的邮箱地址。
number
商户类型：
1 = INDIVIDUAL（个人），2 = BUSINESS（企业）。number
KYC/KYB 状态：
1 = 认证中，2 = 正常，3 = 失败，4 = 未完成。string
KYC/KYB 验证被拒绝时提供的原因。
number
待处理的限额提升申请的状态：
1 = 认证中，2 = 正常，3 = 失败，4 = 未完成。string
限额提升申请被拒绝的原因（如适用）。
number
商户每日可交易的最大法币金额。
number
今日已占用每日限额的法币金额。
number
商户每个自然月可交易的最大法币金额。
number
本月已占用每月限额的法币金额。
number
商户每月可交易的最大加密货币等值金额（以 USD 计）。
number
已占用每月加密货币限额的等值金额。
string
附加在商户记录上的自由文本备注。
string
商户创建时间的 Unix 时间戳（毫秒）。
string
商户记录最后更新时间的 Unix 时间戳（毫秒）。
示例
cURL
curl -G https://api.velafi.com/v2/merchants \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "status=-1" \
--data-urlencode "currentPage=1" \
--data-urlencode "pageSize=10"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"currentPage": 1,
"size": 10,
"total": 100,
"record": [
{
"merchantId": 1,
"country": "Mexico",
"merchantName": "Arturo Tellez",
"email": "tellez@example.com",
"merchantType": 1,
"status": 2,
"rejectReason": "",
"upgradeMerchantLimitStatus": 2,
"upgradeMerchantLimitRejectReason": "",
"dayFiatLimit": 25000.0,
"dayFiatUsed": 0.0,
"monthFiatLimit": 25000.0,
"monthFiatUsed": 0.0,
"monthCryptoLimit": 15000.0,
"monthCryptoUsed": 0.0,
"remark": "",
"createTime": "1737452292000",
"updateTime": "1737452344000"
}
]
}
}
使用
status=-1 可获取处于所有 KYC 阶段的商户，包括验证失败或仍在进行中的商户。⌘I
获取商户列表
curl --request GET \
--url https://api-test.velafi.com/v2/merchants \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchants"
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/merchants', 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/merchants")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"merchantId": 123,
"country": "<string>",
"merchantName": "<string>",
"email": "<string>",
"merchantType": 123,
"status": 123,
"rejectReason": "<string>",
"upgradeMerchantLimitStatus": 123,
"upgradeMerchantLimitRejectReason": "<string>",
"dayFiatLimit": 123,
"dayFiatUsed": 123,
"monthFiatLimit": 123,
"monthFiatUsed": 123,
"monthCryptoLimit": 123,
"monthCryptoUsed": 123,
"remark": "<string>",
"createTime": "<string>",
"updateTime": "<string>"
}
]
}
}