Comercios
Listar cuentas de comercio
Obtén una lista paginada de las cuentas de pago fiat de los comercios con su estado de activación, saldos actuales y límites mensuales de transacciones.
GET
/
v2
/
merchant
/
accounts
Listar cuentas de comercio
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>"
}
]
}
}Usa este endpoint para consultar las cuentas de pago fiat asociadas a uno o más comercios. Cada registro de cuenta muestra la moneda, el saldo actual, los detalles del canal y los límites mensuales de compra y venta con sus cifras de uso. Puedes filtrar por ID de comercio, moneda o estado de activación para acotar los resultados.
Todas las solicitudes deben incluir el header
X-BH-TOKEN con un token de negocio de GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/merchant/accounts
Parámetros de consulta
integer
Filtra por el ID único del comercio (MID).
string
Filtra por nombre del comercio.
string
Filtra por dirección de correo electrónico del comercio.
string
Filtra por código de moneda fiat, por ejemplo
MXN, ARS, BRL.integer
Filtra por estado de activación de la cuenta:
1— pendiente2— activa3— fallida4— incompleta
integer
Número de página que se va a obtener (empieza en 1). El valor predeterminado es
1.integer
Número de registros por página. El valor predeterminado es
10 y el máximo es 1000.Campos de la respuesta
number
Código de respuesta de tipo 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 devuelta.
number
Número de registros en esta página.
number
Número total de cuentas que coinciden con la consulta.
array
Mostrar campos de cada elemento de record
Mostrar campos de cada elemento de record
number
Identificador único del comercio.
string
Moneda fiat de esta cuenta.
string
Saldo actual en la moneda fiat.
number
Estado de la cuenta:
0 = inicializada, 1 = pendiente, 2 = activa, 3 = fallida, 4 = incompleta. Los canales cerrados o deshabilitados también se reportan como 1. Los registros se listan por configuración de canal, así que un canal que todavía está pendiente o incompleto puede no aparecer aún.number
ID de la configuración del canal de pago.
string
Nombre legible del método de pago (por ejemplo,
Automated Bank Transfer(Mexico)).string
Límite mensual de compra (on-ramp) en fiat para esta cuenta.
string
Monto en fiat usado este mes contra el límite mensual de compra.
string
Límite mensual de venta (off-ramp) en fiat para esta cuenta.
string
Monto en fiat usado este mes contra el límite mensual de venta.
string
Motivo de la falla de activación, si aplica.
string
Marca de tiempo Unix (milisegundos) de cuando se creó la cuenta.
string
Marca de tiempo Unix (milisegundos) de la última actualización de la cuenta.
Ejemplo
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
Listar cuentas de comercio
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>"
}
]
}
}