Comercios
Listar cuentas virtuales
Obtén una lista paginada de las subcuentas virtuales de un comercio y sus datos bancarios en todas las monedas fiat admitidas.
GET
/
v2
/
merchant
/
virtual
/
addfunds
Listar cuentas virtuales
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": {}
}
]
}
}Usa este endpoint para listar las cuentas virtuales creadas para un comercio. Cada registro incluye el alias de la cuenta virtual, el nombre del método de pago y los datos bancarios específicos necesarios para fondearla (por ejemplo, un número CLABE, un CVU o un código QR de Pix). Es la contraparte de lectura del endpoint Crear cuentas virtuales y admite paginación para comercios con muchas cuentas virtuales.
Todas las solicitudes deben incluir el header
X-BH-TOKEN con un token de negocio obtenido de GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/merchant/virtual/addfunds
Parámetros de consulta
integer
requerido
El ID del comercio.
integer
requerido
ID del canal de pago. Valores admitidos:
105— SPEI (Finco Pay), MXN72— SPEI (Tesored), MXN63— CBU/CVU (Momentum), ARS137— QR Argentina, ARS (QR estático)68— Automatic ACH (link de pago), COP69— Bre-B, COP (solo después de que se haya creado la llave Bre-B del comercio)90— Pix (Genial), BRL92— Pix - Woovi (Avenia), BRL (QR estático)
string
requerido
Moneda fiat. Valores admitidos:
MXN, ARS, COP, BRL.string
Filtra por un alias de cuenta virtual específico.
integer
Número de página a obtener (empieza en 1). El valor predeterminado es
1.integer
Registros por página. El valor predeterminado es
10. Los valores mayores a 100 se limitan a 100; los valores mayores a 1000 se rechazan.Campos de la respuesta
number
Código de respuesta de estilo HTTP.
200 indica éxito.string
Mensaje de estado legible, por ejemplo
SUCCESS.object
Mostrar campos de data
Mostrar campos de data
number
Número de la página actual devuelta.
number
Número de registros en esta página.
number
Número total de cuentas virtuales que coinciden con la consulta.
array
Mostrar campos de cada elemento de record
Mostrar campos de cada elemento de record
string
Moneda fiat de la cuenta virtual.
string
Alias que identifica esta cuenta virtual.
string
Nombre legible del método de pago.
number
Estado:
1 = en autenticación, 2 = normal (activa), 3 = autenticación fallida.object
Mapa de nombres de campos de datos bancarios a sus valores. Las claves son las mismas que en Obtener cuenta Pending Fund. Este endpoint no recibe
amount, así que nunca devuelve un QR específico de un depósito ni un txId.Ejemplos
- 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"
}
}
]
}
}
⌘I
Listar cuentas virtuales
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": {}
}
]
}
}