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

Consultar el resumen financiero del mes

Audiencia
public
Autenticación
API key
Permiso
finance:generate_self
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, null cuando 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ámetros
ParámetroUbicaciónTipoObligatorioDescripción
month*querystringobligatorio

Mes a consultar 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/summary' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200FinanceSummaryResponse — KPIs mensuales del usuario con comparativa al mes anterior.
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_summary.

p. ej. finance_summary
attributesobject

Indicadores financieros de la cuenta para un mes calendario, con agregados, desgloses y comparación con el mes anterior.

periodobject

Rango temporal del resumen (mes calendario completo).

monthstring

Mes en formato YYYY-MM.

p. ej. 2026-04
from_utcstring

Inicio del mes en UTC, con formato YYYY-MM-DD HH:MM:SS.

p. ej. 2026-04-01 06:00:00
to_utcstring

Fin del mes en UTC (exclusivo), con formato YYYY-MM-DD HH:MM:SS.

p. ej. 2026-05-01 06:00:00
countsobject

Conteos de validaciones por veredicto, más retiros mediante borrado lógico del periodo (informativo).

totalinteger

Cantidad de validaciones del periodo, incluidas las que tienen estado pending.

p. ej. 287
validinteger

Validaciones con veredicto valid en el periodo.

p. ej. 228
invalidinteger

Validaciones con veredicto invalid en el periodo.

p. ej. 4
not_foundinteger

Validaciones con veredicto not_found en el periodo.

p. ej. 32
cep_unavailableinteger

Validaciones con veredicto cep_unavailable en el periodo.

p. ej. 18
returnedinteger

Validaciones cuya operación se liquidó y después se devolvió en el periodo.

p. ej. 4
errorinteger

Validaciones que terminaron en error técnico.

p. ej. 3
pendinginteger

Validaciones aún en proceso que no han recibido estado terminal al cierre del periodo.

p. ej. 2
deletedinteger

Validaciones retiradas mediante borrado lógico en el periodo.

p. ej. 6
amountsobject

Agregados monetarios del periodo. verified_volume suma únicamente validaciones con resultado valid.

total_volumenumber

Importe sumado en MXN de todas las validaciones del periodo.

p. ej. 1234567.89
verified_volumenumber

Volumen en MXN de validaciones con resultado valid.

p. ej. 980123.45
unverified_volumenumber

Diferencia entre volumen total y verificado.

p. ej. 254444.44
avg_ticketnumber

Monto promedio por validación en MXN.

p. ej. 4302.32
median_ticketnumber

Monto mediano por validación en MXN.

p. ej. 3100
max_ticketnumber

Mayor monto individual del mes en MXN.

p. ej. 250000
min_ticketnumber

Menor monto individual del mes en MXN.

p. ej. 50
verified_share_pctnumber

Porcentaje del volumen total correspondiente a validaciones verificadas, expresado de 0 a 100.

p. ej. 79.4
success_ratenumber

Tasa de éxito: porcentaje de validaciones con resultado valid sobre counts.total, expresado de 0 a 100.

p. ej. 79.4
avg_processing_msinteger

Tiempo promedio de procesamiento en milisegundos del periodo.

p. ej. 412
daily_breakdownarray

Desglose diario con actividad. Los días sin validaciones se omiten.

top_counterpartiesarray

Top 5 cuentas beneficiarias del usuario por volumen verificado en el mes.

top_banks_receptorarray

Top 5 bancos receptores por volumen verificado.

top_banks_emisorarray

Top 5 bancos emisores por volumen verificado.

verdict_distributionobject

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_monthobject

Comparativa contra el mes anterior. Los deltas son null cuando el mes anterior tuvo base cero (crecimiento no definido).

prev_monthstring

Mes anterior en formato YYYY-MM.

p. ej. 2026-03
totalinteger

Cantidad de validaciones del mes anterior.

p. ej. 251
verified_volumenumber

Volumen verificado del mes anterior en MXN.

p. ej. 880000
total_delta_pctnumber | nullanulable

Cambio porcentual del conteo total respecto al mes anterior. null cuando el mes anterior tuvo cero validaciones.

p. ej. 14.3
volume_delta_pctnumber | nullanulable

Cambio porcentual del volumen verificado respecto al mes anterior. null cuando el mes anterior tuvo cero volumen verificado.

p. ej. 11.4
foliostring

Folio determinístico del estado de cuenta del mes, idéntico al devuelto en la cabecera X-Finance-Folio del endpoint de exportación.

p. ej. A3F12B9C0D4E
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/summary
CódigoClaseDescripciónCuerpo
2002xxKPIs mensuales del usuario con comparativa al mes anterior.FinanceSummaryResponse
4004xxParámetro month inválido o ausenteErrorResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
Cabeceras de respuesta200
CabeceraTipoDescripción
Cache-ControlstringDirectiva de caché privada.
Errores de GET /v1/finance/summary
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