Merchants
List Virtual Accounts
Retrieve a paginated list of virtual sub-accounts and their banking credentials for a merchant across all supported fiat currencies.
GET
/
v2
/
merchant
/
virtual
/
addfunds
List Virtual Accounts
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": {}
}
]
}
}Use this endpoint to list the virtual accounts created for a merchant. Each record includes the virtual account’s alias, payment method name, and the specific banking credentials needed to fund it (e.g., a CLABE number, CVU, or Pix QR code). This is the read-counterpart to the Create Virtual Accounts endpoint and supports pagination for merchants with many virtual accounts.
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/virtual/addfunds
Query Parameters
integer
required
The ID of the merchant.
integer
required
Payment channel ID. Supported values:
105— SPEI (Finco Pay), MXN72— SPEI (Tesored), MXN63— CBU/CVU (Momentum), ARS137— QR Argentina, ARS (static QR)68— Automatic ACH (payment link), COP69— Bre-B, COP (only after the merchant’s Bre-B key has been created)90— Pix (Genial), BRL92— Pix - Woovi (Avenia), BRL (static QR)
string
required
Fiat currency. Supported values:
MXN, ARS, COP, BRL.string
Filter by a specific virtual account alias.
integer
Page number to retrieve (1-based). Defaults to
1.integer
Records per page. Default is
10. Values above 100 are capped at 100; values above 1000 are rejected.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 virtual accounts matching the query.
array
Show record item fields
Show record item fields
string
Fiat currency of the virtual account.
string
Alias identifier for this virtual account.
string
Human-readable payment method name.
number
Status:
1 = authenticating, 2 = normal (active), 3 = authentication failed.object
Map of banking credential field names to values. The keys are the same as in Get Pending Fund Account. This endpoint takes no
amount, so it never returns a deposit-specific QR or txId.Examples
- 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://example.com/pix-qr-code.png"
}
}
]
}
}
Was this page helpful?
⌘I
List Virtual Accounts
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": {}
}
]
}
}