https://api.veriko.mx/v1/finance/by-bank Resumen por banco receptor (CSV / XLSX / PDF / preview)
Guía de uso →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 comoFinancePreviewResponse.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
format | query | string | opcional | Formato de salida. Predeterminado: |
month * | query | string | obligatorio | Mes a reportar en formato `YYYY-MM`. |
user_id | query | string (uuid) | opcional | Solo para administradores con `finance:generate_all`. UUID del usuario a consultar. |
curl -X GET 'https://api.veriko.mx/v1/finance/by-bank' \
-H 'Authorization: Bearer mxcep_••••'
Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Campo | Tipo | Descripción |
|---|---|---|
type | string | Tipo del recurso JSON:API (siempre `finance_preview`). |
attributes | object | Campos del preview del reporte. |
report | string | Tipo de reporte: `monthly` — estado de cuenta mensual; `counterparties` — top contrapartes; `by-bank` — desglose por banco; `accounting` — libro diario contable. |
month | string | Mes del reporte en formato YYYY-MM. |
headers | array | Nombres de las columnas del CSV, en el mismo orden que las filas en `rows`. |
rows | array (elementos: ?–20) | Primeras 20 filas de datos del reporte (máximo). |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Stream CSV/XLSX/PDF, o envelope JSON en modo preview. | 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 |
| Cabecera | Tipo | Descripción |
|---|---|---|
Cache-Control | string | Disables intermediary caching de la descarga (no aplica al modo preview). |
Content-Disposition | string | Nombre de archivo sugerido (no aplica al modo preview). |
| Código | Clave | Detalle |
|---|---|---|
| 400 | invalid_month | 'month' is required and must be YYYY-MM. Envelope
|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|