Saltar al contenido principal
GET
Listar comercios
Usa este endpoint para consultar los comercios registrados en tu cuenta. Puedes filtrar por nombre, correo electrónico o estado de verificación, y paginar los resultados. La respuesta incluye el estado KYC de cada comercio, sus límites de transacción diarios y mensuales y su uso actual, lo que resulta útil para monitorear el margen disponible de cumplimiento.
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/merchants

Parámetros de consulta

string
Filtra los resultados por nombre del comercio (admite coincidencia parcial).
string
Filtra los resultados por la dirección de correo electrónico del comercio.
integer
Filtra por estado de verificación KYC/KYB:
  • -1 — todos los estados
  • 1 — en autenticación
  • 2 — normal (predeterminado)
  • 3 — autenticación fallida
  • 4 — incompleto
integer
Número de página 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 estilo HTTP. 200 indica éxito.
string
Mensaje de estado legible, por ejemplo SUCCESS.
object

Ejemplo

cURL
Response
Usa status=-1 para obtener comercios en todas las etapas de KYC, incluidos los que fallaron o siguen en proceso.