GEThttps://api.veriko.mx/v1/finance/counterparties

Obtener el resumen por contraparte (CSV, XLSX o PDF)

Audiencia
public
Autenticación
API key
Permiso
finance:generate_self
Guía de uso →

Agrupa las verificaciones del mes por cuenta beneficiaria y banco, incluye 7 columnas:

  • Cuenta beneficiaria.
  • Banco.
  • Verificaciones.
  • Válidas.
  • Monto total.
  • Primera.
  • Última.

El resumen puede ser solicitado en alguno de los siguientes formatos: format=csv (predeterminado), format=xlsx, format=pdf (máximo 1000 filas).
Además se puede usar format=preview para obtener las primeras 20 filas como JSON.

Para más información sobre exportaciones consulta exportaciones y formatos.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
formatquerystringopcional

Formato de archivo solicitado para descarga. Aceptados: csv, xlsx, pdf o preview.

Predeterminado: csv

p. ej. csv
limitqueryintegeropcional

Recorta el número de filas cuando la salida es csv o xlsx. No afecta al PDF, que lleva su propio tope de 1000 filas.

p. ej. 500
month*querystringobligatorio

Mes a reportar en formato YYYY-MM.

p. ej. 2026-04
user_idquerystring (uuid)opcional

Solo para administradores — UUID del usuario a consultar.

p. ej. f47ac10b-58cc-4372-a567-0e02b2c3d479
Petición
curl -X GET 'https://api.veriko.mx/v1/finance/counterparties' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200FinancePreviewResponse — Stream CSV/XLSX/PDF, o envelope JSON en modo vista previa.
CampoTipoDescripción
dataobject

Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con type, id, attributes).

typestring

Tipo del recurso JSON:API. Siempre finance_preview.

p. ej. finance_preview
attributesobject

Datos de la vista previa del reporte.

reportstring

Tipo de reporte — monthly: estado de cuenta mensual; counterparties: top contrapartes; by-bank: desglose por banco; accounting: libro diario contable.

p. ej. monthly
monthstring

Mes del reporte en formato YYYY-MM.

p. ej. 2026-04
headersarray

Nombres de las columnas para formato CSV (en el mismo orden que las filas en rows).

p. ej. ["Fecha","Folio plataforma","Tipo","Clave de rastreo","Fecha operación","Monto","Banco emisor","CLABE emisora","Banco receptor","CLABE receptora","Beneficiario","Veredicto Banxico","CEP disponible","Folio CEP","Tiempo (ms)"]
rowsarray (elementos: ?–20)

Primeras 20 filas (máximo) de datos del reporte.

p. ej. [["2026-04-15 10:32:00","c3d4e5f6-a7b8-9012-cdef-123456789012","direct","MXBA20260415001234","2026-04-15","15000.50","BBVA MEXICO","012180001234567891","BANORTE","072180009876543210","Comercializadora Ejemplo SA de CV","valid","Sí","","412"]]
metaobject

Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.

versionstring

Versión de la API que procesó la petición.

p. ej. 1.47.0
api_versionstring

Versión del prefijo de ruta de la API (ej. v1).

p. ej. v1
request_idstring

Identificador único de la petición (hex).

p. ej. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

Descriptor compañero presente en el bloque meta de cada respuesta (y en el meta del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.

p. ej. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Siempre UTC: La zona canónica para cada campo datetime del cuerpo.

p. ej. UTC
format*string

Siempre ISO 8601: Sufijo Z explícito en cada datetime.

p. ej. ISO 8601
linksobject

Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Códigos de respuestaGET /v1/finance/counterparties
CódigoClaseDescripciónCuerpo
2002xxStream CSV/XLSX/PDF, o envelope JSON en modo vista previa.FinancePreviewResponse
4004xxParámetro month inválido o ausenteErrorResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
5005xxpdf_render_failed: Reintentar con otro formato.ErrorResponse
Cabeceras de respuesta200
CabeceraTipoDescripción
Cache-ControlstringDeshabilita el almacenamiento en caché por parte de intermediarios durante la descarga (no aplica al modo vista previa).
Content-DispositionstringNombre de archivo sugerido (no aplica al modo vista previa).
Errores de GET /v1/finance/counterparties
CódigoClaveEjemplo
400invalid_month

'month' es obligatorio y debe tener el formato YYYY-MM.

Envelope
meta.request_id
d5e6f7a8b9c11c9b8a7f6e5d
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d