https://api.veriko.mx/v1/finance/summaryConsultar el resumen financiero del mes
Guía de uso →Devuelve los KPIs del mes para el panel /finanzas:
- Conteos por veredicto
- Agregados monetarios (volumen total / verificado / no verificado, ticket promedio, mediana, mínimo, máximo, share verificado)
- Tasa de éxito
- Tiempo de procesamiento promedio
- Desglose diario
- Contrapartes y bancos emisores/receptores
- Distribución de veredicto y comparativa con el mes anterior (deltas porcentuales,
nullcuando el mes previo tuvo base cero)
"Verificado" significa que Banxico devolvió valid y el CEP fue encontrado. Cualquier otro veredicto cuenta como no verificado.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
month* | query | string | obligatorio | Mes a consultar en formato 2026-04 |
user_id | query | string (uuid) | opcional | Solo para administradores — UUID del usuario a consultar. p. ej.f47ac10b-58cc-4372-a567-0e02b2c3d479 |
curl -X GET 'https://api.veriko.mx/v1/finance/summary' \
-H 'Authorization: Bearer veriko_••••'Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| 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 | string | Tipo del recurso JSON:API. Siempre finance_summary |
attributes | object | Indicadores financieros de la cuenta para un mes calendario, con agregados, desgloses y comparación con el mes anterior. |
period | object | Rango temporal del resumen (mes calendario completo). |
month | string | Mes en formato 2026-04 |
from_utc | string | Inicio del mes en UTC, con formato 2026-04-01 06:00:00 |
to_utc | string | Fin del mes en UTC (exclusivo), con formato 2026-05-01 06:00:00 |
counts | object | Conteos de validaciones por veredicto, más retiros mediante borrado lógico del periodo (informativo). |
total | integer | Cantidad de validaciones del periodo, incluidas las que tienen estado 287 |
valid | integer | Validaciones con veredicto 228 |
invalid | integer | Validaciones con veredicto 4 |
not_found | integer | Validaciones con veredicto 32 |
cep_unavailable | integer | Validaciones con veredicto 18 |
returned | integer | Validaciones cuya operación se liquidó y después se devolvió en el periodo. p. ej.4 |
error | integer | Validaciones que terminaron en error técnico. p. ej.3 |
pending | integer | Validaciones aún en proceso que no han recibido estado terminal al cierre del periodo. p. ej.2 |
deleted | integer | Validaciones retiradas mediante borrado lógico en el periodo. p. ej.6 |
amounts | object | Agregados monetarios del periodo. |
total_volume | number | Importe sumado en MXN de todas las validaciones del periodo. p. ej.1234567.89 |
verified_volume | number | Volumen en MXN de validaciones con resultado 980123.45 |
unverified_volume | number | Diferencia entre volumen total y verificado. p. ej.254444.44 |
avg_ticket | number | Monto promedio por validación en MXN. p. ej.4302.32 |
median_ticket | number | Monto mediano por validación en MXN. p. ej.3100 |
max_ticket | number | Mayor monto individual del mes en MXN. p. ej.250000 |
min_ticket | number | Menor monto individual del mes en MXN. p. ej.50 |
verified_share_pct | number | Porcentaje del volumen total correspondiente a validaciones verificadas, expresado de 0 a 100. p. ej.79.4 |
success_rate | number | Tasa de éxito: porcentaje de validaciones con resultado 79.4 |
avg_processing_ms | integer | Tiempo promedio de procesamiento en milisegundos del periodo. p. ej.412 |
daily_breakdown | array | Desglose diario con actividad. Los días sin validaciones se omiten. |
top_counterparties | array | Top 5 cuentas beneficiarias del usuario por volumen verificado en el mes. |
top_banks_receptor | array | Top 5 bancos receptores por volumen verificado. |
top_banks_emisor | array | Top 5 bancos emisores por volumen verificado. |
verdict_distribution | object | Conteo de validaciones por valor de veredicto. Los valores ausentes implican cero. p. ej.{"valid":228,"not_found":32,"cep_unavailable":18,"invalid":4,"returned":4,"error":3} |
comparison_prev_month | object | Comparativa contra el mes anterior. Los deltas son |
prev_month | string | Mes anterior en formato 2026-03 |
total | integer | Cantidad de validaciones del mes anterior. p. ej.251 |
verified_volume | number | Volumen verificado del mes anterior en MXN. p. ej.880000 |
total_delta_pct | number | nullanulable | Cambio porcentual del conteo total respecto al mes anterior. 14.3 |
volume_delta_pct | number | nullanulable | Cambio porcentual del volumen verificado respecto al mes anterior. 11.4 |
folio | string | Folio determinístico del estado de cuenta del mes, idéntico al devuelto en la cabecera A3F12B9C0D4E |
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 |
request_id | string | Identificador único de la petición (hex). p. ej.a1b2c3d4e5f66f5e4d3c2b1a |
datetime | object | Descriptor compañero presente en el bloque {"timezone":"UTC","format":"ISO 8601"} |
timezone* | string | Siempre UTC |
format* | string | Siempre ISO 8601 |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | KPIs mensuales del usuario con comparativa al mes anterior. | FinanceSummaryResponse |
| 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 |
| Cabecera | Tipo | Descripción |
|---|---|---|
Cache-Control | string | Directiva de caché privada. |
| Código | Clave | Ejemplo |
|---|---|---|
| 400 | invalid_month | 'month' es obligatorio y debe tener el formato YYYY-MM. Envelope
|
| 401 | unauthorized | Credenciales de autenticación ausentes o inválidas. Envelope
|
| 403 | permission_denied | No tienes permiso para acceder a este recurso. Envelope
|