← Volver al índice de esquemas
FinanceSummaryAttributes
KPIs financieros del usuario para un mes calendario. Incluye conteos por veredicto Banxico, agregados monetarios, desglose diario, top contrapartes y bancos, distribución de veredicto, y comparativa con el mes anterior.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
period | object | Rango temporal del resumen (mes calendario completo). |
month | string | Mes en formato YYYY-MM. |
from_utc | string (date-time) | Inicio del mes en UTC (ISO 8601). |
to_utc | string (date-time) | Fin del mes en UTC (ISO 8601, exclusivo). |
counts | object | Conteos de validaciones por veredicto Banxico más soft-deletes del periodo (informativo). |
total | integer | Total de validaciones completadas en el periodo (excluye `pending`). |
valid | integer | Validaciones con veredicto Banxico `valid` en el periodo. |
invalid | integer | Validaciones con veredicto Banxico `invalid` en el periodo. |
not_found | integer | Validaciones con veredicto Banxico `not_found` en el periodo. |
cep_unavailable | integer | Validaciones con veredicto Banxico `cep_unavailable` en el periodo. |
error | integer | Validaciones que terminaron en error técnico (Banxico no respondió, timeout, etc.) en el periodo. |
pending | integer | Validaciones aún en proceso (asíncronas que no han recibido respuesta de Banxico) al cierre del periodo. |
deleted | integer | Validaciones eliminadas (soft-delete) en el periodo. |
amounts | object | Agregados monetarios del periodo. `verified_volume` suma únicamente validaciones con resultado `valid`. |
total_volume | number | Volumen total en MXN. |
verified_volume | number | Volumen en MXN de validaciones con resultado `valid`. |
unverified_volume | number | Diferencia entre volumen total y verificado. |
avg_ticket | number | Monto promedio por validación en MXN. |
median_ticket | number | Monto mediano por validación en MXN. |
max_ticket | number | Mayor monto individual del mes en MXN. |
min_ticket | number | Menor monto individual del mes en MXN. |
verified_share_pct | number | Porcentaje del volumen total correspondiente a validaciones verificadas, expresado de 0 a 100. |
success_rate | number | Tasa de éxito: porcentaje de validaciones con resultado `valid` sobre el total completado, expresado de 0 a 100. |
avg_processing_ms | integer | Tiempo promedio de procesamiento en milisegundos del periodo. |
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 Banxico. Los valores ausentes implican cero. |
comparison_prev_month | object | Comparativa contra el mes anterior. Los deltas son `null` cuando el mes anterior tuvo base cero (crecimiento no definido). |
prev_month | string | Mes anterior en formato YYYY-MM. |
total | integer | Total de validaciones del mes anterior. |
verified_volume | number | Volumen verificado del mes anterior en MXN. |
total_delta_pct | number | null | Cambio porcentual del conteo total respecto al mes anterior. `null` cuando el mes anterior tuvo cero validaciones. |
volume_delta_pct | number | null | Cambio porcentual del volumen verificado respecto al mes anterior. `null` cuando el mes anterior tuvo cero volumen verificado. |
folio | string | Folio determinístico del estado de cuenta del mes, idéntico al devuelto en la cabecera `X-Finance-Folio` del endpoint de exportación. |
Usado en operaciones
GET /v1/finance/summary