商户
获取商户账户列表
获取商户法币支付账户的分页列表,包括其激活状态、当前余额和每月交易限额。
GET
/
v2
/
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>"
}
]
}
}使用此端点查看与一个或多个商户关联的法币支付账户。每条账户记录都会显示币种、当前余额、渠道详情,以及每月买入和卖出限额及其使用情况。您可以按商户 ID、币种或激活状态进行筛选以缩小结果范围。
所有请求都必须包含
X-BH-TOKEN 请求头,其中包含通过 GET /v2/token/generate 获取的业务令牌。端点
GET https://api.velafi.com/v2/merchant/accounts
查询参数
integer
按商户唯一 ID (MID) 筛选。
string
按商户名称筛选。
string
按商户电子邮件地址筛选。
string
按法币代码筛选,例如
MXN、ARS、BRL。integer
按账户激活状态筛选:
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
以该法币计的当前余额。
number
账户状态:
0 = 已初始化,1 = 待处理,2 = 已激活,3 = 失败,4 = 不完整。已关闭或已停用的渠道也会报告为 1。记录按渠道配置列出,因此仍处于待处理或不完整状态的渠道可能尚未列出。number
支付渠道配置的 ID。
string
支付方式的可读名称(例如
Automated Bank Transfer(Mexico))。string
此账户的每月买入(入金)法币限额。
string
本月已使用的每月买入限额法币金额。
string
此账户的每月卖出(出金)法币限额。
string
本月已使用的每月卖出限额法币金额。
string
激活失败的原因(如适用)。
string
账户创建时的 Unix 时间戳(毫秒)。
string
账户最后更新时的 Unix 时间戳(毫秒)。
示例
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"
}
]
}
}
⌘I
获取商户账户列表
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>"
}
]
}
}
