商户
获取虚拟账户列表
分页获取商户在所有支持的法币下的虚拟子账户及其银行账户信息。
GET
/
v2
/
merchant
/
virtual
/
addfunds
获取虚拟账户列表
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/virtual/addfunds \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/virtual/addfunds"
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/virtual/addfunds', 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/virtual/addfunds")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"fiat": "<string>",
"depositAlias": "<string>",
"paymentMethodName": "<string>",
"status": 123,
"fieldList": {}
}
]
}
}使用此接口列出为某个商户创建的虚拟账户。每条记录都包含虚拟账户的别名、支付方式名称,以及为其充值所需的具体银行账户信息(例如 CLABE 号码、CVU 或 Pix 二维码)。此接口是创建虚拟账户接口对应的查询接口,并支持分页,适用于拥有大量虚拟账户的商户。
所有请求都必须在
X-BH-TOKEN 请求头中携带通过 GET /v2/token/generate 获取的业务 token。接口地址
GET https://api.velafi.com/v2/merchant/virtual/addfunds
查询参数
integer
必填
商户 ID。
integer
必填
支付通道 ID。支持的取值:
105— SPEI (Finco Pay),MXN72— SPEI (Tesored),MXN63— CBU/CVU (Momentum),ARS137— QR Argentina,ARS(静态二维码)68— Automatic ACH(支付链接),COP69— Bre-B,COP(仅在商户的 Bre-B key 创建后)90— Pix (Genial),BRL92— Pix - Woovi (Avenia),BRL(静态二维码)
string
必填
法币币种。支持的取值:
MXN、ARS、COP、BRL。string
按指定的虚拟账户别名筛选。
integer
要获取的页码(从 1 开始)。默认为
1。integer
每页记录数。默认为
10。超过 100 的值会被限制为 100;超过 1000 的值会被拒绝。响应字段
number
HTTP 风格的响应码。
200 表示成功。string
可读的状态信息,例如
SUCCESS。object
示例
- MXN
- ARS
- BRL (Pix)
cURL
curl -G https://api.velafi.com/v2/merchant/virtual/addfunds \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=151209" \
--data-urlencode "fiat=MXN" \
--data-urlencode "paymentId=105"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"currentPage": 1,
"size": 10,
"total": 50,
"record": [
{
"fiat": "MXN",
"depositAlias": "store001",
"paymentMethodName": "SPEI - FINCO PAY",
"fieldList": {
"Cuenta CLABE": "000000000000000001"
}
}
]
}
}
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"currentPage": 1,
"size": 10,
"total": 5,
"record": [
{
"fiat": "ARS",
"depositAlias": "arg-store",
"paymentMethodName": "Automated Bank Transfer (Argentina)",
"fieldList": {
"CVU Number": "0000000000000000000003",
"CUIT": "20000000002"
}
}
]
}
}
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"currentPage": 1,
"size": 10,
"total": 3,
"record": [
{
"fiat": "BRL",
"depositAlias": "brl-main",
"paymentMethodName": "Automated Pix",
"fieldList": {
"Pix copia e cola": "00020101021126580014br.gov.bcb.pix013865755...",
"Pix QR Code": "https://links.qrcode.co/zAOCe/3471397f291c28d19.png"
}
}
]
}
}
⌘I
获取虚拟账户列表
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/virtual/addfunds \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/virtual/addfunds"
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/virtual/addfunds', 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/virtual/addfunds")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"fiat": "<string>",
"depositAlias": "<string>",
"paymentMethodName": "<string>",
"status": 123,
"fieldList": {}
}
]
}
}
