Obtener el resumen por banco receptor (CSV, XLSX o PDF)

GEThttps://api.veriko.mx/v1/finance/by-bank

Audiencia: public
Autenticación: API key
Permiso: finance:generate_self

Agrupa las verificaciones del mes por banco receptor (banxico_code), con totales, conteo de válidas, tasa de éxito y monto total. 6 columnas: Clave Banxico, Banco, Verificaciones, Válidas, Tasa éxito %, Monto total.

La fila de Totales en el PDF reporta la tasa de éxito agregada ponderada por filas (sum(válidas) * 100 / sum(verificaciones)), NO el promedio simple de las tasas por fila — ese promedio engañaría cuando un banco con 1 fila a 100 % se mezcla con otro de 1000 filas a 50 %.

format=csv (predeterminado, text/csv) / format=xlsx (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet): lista plana.
format=pdf (application/pdf): ledger con fila Totales. Cap 1000 filas.
format=preview (application/json): primeras 20 filas como FinancePreviewResponse.

Lo común a todas las exportaciones —la cabecera de descarga, qué pasa cuando falla a mitad y los topes— está en exportaciones y formatos.

Parámetros
Parámetro	Ubicación	Tipo	Obligatorio	Descripción
`format`	query	`string`	opcional	Formato del archivo. `csv` y `xlsx` son datos para hoja de cálculo; `pdf` es el documento listo para archivar o enviar; `preview` devuelve los mismos datos en JSON para pintarlos en pantalla sin descargar nada. Predeterminado: `csv` p. ej. `csv`
`limit`	query	`integer`	opcional	Recorta el número de filas cuando la salida es `csv` o `xlsx`. Solo baja el tope: un valor mayor que 100 000, o menor que 1, lo deja como estaba. No afecta al PDF, que lleva su propio tope de 1000 filas. p. ej. `500`
`month`*	query	`string`	obligatorio	Mes a reportar en formato `YYYY-MM`. p. ej. `2026-04`
`user_id`	query	`string (uuid)`	opcional	Solo para administradores con `finance:generate_all`. UUID del usuario a consultar. p. ej. `f47ac10b-58cc-4372-a567-0e02b2c3d479`

Petición

cURLPython•JavaScript•PHP•

curl -X GET 'https://api.veriko.mx/v1/finance/by-bank' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

**Respuesta 200**`FinancePreviewResponse` — Stream CSV/XLSX/PDF, o envelope JSON en modo vista previa.
Campo	Tipo	Descripción
`data`	`object`	Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
`type`	`string`	Tipo del recurso JSON:API (siempre `finance_preview`). p. ej. `finance_preview`
`attributes`	`object`	Campos de la vista previa del reporte.
`report`	`string`	Tipo de reporte: `monthly` — estado de cuenta mensual; `counterparties` — top contrapartes; `by-bank` — desglose por banco; `accounting` — libro diario contable. p. ej. `monthly`
`month`	`string`	Mes del reporte en formato YYYY-MM. p. ej. `2026-04`
`headers`	`array`	Nombres de las columnas del CSV, en el mismo orden que las filas en `rows`. p. ej. `["Fecha","Monto","Clave de rastreo","Estado"]`
`rows`	`array` (elementos: ?–20)	Primeras 20 filas de datos del reporte (máximo). p. ej. `[["2026-04-15","15000.50","MXBA20260415001234","valid"]]`
`meta`	`object`	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.
`version`	`string`	Versión de la API que procesó la petición. p. ej. `1.47.0`
`api_version`	`string`	Versión del prefijo de ruta de la API (ej. `v1`). p. ej. `v1`
`request_id`	`string`	Identificador único de la petición (hex). p. ej. `a1b2c3d4e5f6`
`datetime`	`object`	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`
`links`	`object`	Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

**Códigos de respuesta**`GET /v1/finance/by-bank`
Código	Clase	Descripción	Cuerpo
200	`2xx`	Stream CSV/XLSX/PDF, o envelope JSON en modo vista previa.	`FinancePreviewResponse`
400	`4xx`	Parámetro `month` inválido o ausente	`ErrorResponse`
401	`4xx`	Se requiere autenticación o las credenciales son inválidas	`ErrorResponse`
403	`4xx`	Permisos insuficientes	`ErrorResponse`
500	`5xx`	`pdf_render_failed` — el renderer PDF truena. Probar CSV o XLSX.	`ErrorResponse`

**Cabeceras de respuesta**`200`
Cabecera	Tipo	Descripción
`Cache-Control`	`string`	Disables intermediary caching de la descarga (no aplica al modo vista previa).
`Content-Disposition`	`string`	Nombre de archivo sugerido (no aplica al modo vista previa).

**Errores de `GET /v1/finance/by-bank`**
Código	Clave	Ejemplo
400	`invalid_month`	'month' es obligatorio y debe tener el formato YYYY-MM. Envelope meta.request_id `d5e6f7a8b9c1`
401	`unauthorized`	Credenciales de autenticación ausentes o inválidas. Envelope meta.request_id `c4d5e6f7a8b9`
403	`forbidden`	No tienes permiso para acceder a este recurso. Envelope meta.request_id `d5e6f7a8b9c0`