FinanceSummaryResource
JSON:API wrapper for the financial summary.
Properties
| Field | Type | Description |
|---|---|---|
type | string | JSON:API resource type (always `finance_summary`). |
attributes | object | User financial KPIs for a calendar month. Includes counts by Banxico verdict, monetary aggregates, daily breakdown, top counterparties and banks, verdict distribution, and comparison with the previous month. |
period | object | Time range of the summary (full calendar month). |
month | string | Month in YYYY-MM format. |
from_utc | string (date-time) | Start of the month in UTC (ISO 8601). |
to_utc | string (date-time) | End of the month in UTC (ISO 8601, exclusive). |
counts | object | Validation counts by Banxico verdict plus soft-deletes for the period (informational). |
total | integer | Total validations completed in the period (excludes `pending`). |
valid | integer | Validations with Banxico verdict `valid` in the period. |
invalid | integer | Validations with Banxico verdict `invalid` in the period. |
not_found | integer | Validations with Banxico verdict `not_found` in the period. |
cep_unavailable | integer | Validations with Banxico verdict `cep_unavailable` in the period. |
error | integer | Validations that ended with a technical error (Banxico did not respond, timeout, etc.) in the period. |
pending | integer | Validations still in progress (async ones awaiting Banxico response) at the end of the period. |
deleted | integer | Soft-deleted validations in the period. |
amounts | object | Monetary aggregates for the period. `verified_volume` sums only validations with `valid` result. |
total_volume | number | Total volume in MXN. |
verified_volume | number | Volume in MXN of validations with `valid` result. |
unverified_volume | number | Difference between total and verified volume. |
avg_ticket | number | Average amount per validation in MXN. |
median_ticket | number | Median amount per validation in MXN. |
max_ticket | number | Largest individual amount in the month in MXN. |
min_ticket | number | Smallest individual amount in the month in MXN. |
verified_share_pct | number | Percentage of total volume from verified validations, expressed from 0 to 100. |
success_rate | number | Success rate: percentage of validations with `valid` result out of all completed, expressed from 0 to 100. |
avg_processing_ms | integer | Average processing time in milliseconds for the period. |
daily_breakdown | array | Daily breakdown for days with activity. Days with no validations are omitted. |
top_counterparties | array | Top 5 user beneficiary accounts by verified volume in the month. |
top_banks_receptor | array | Top 5 receiving banks by verified volume. |
top_banks_emisor | array | Top 5 sending banks by verified volume. |
verdict_distribution | object | Validation count by Banxico verdict value. Missing values imply zero. |
comparison_prev_month | object | Comparison against the previous month. Deltas are `null` when the previous month had a zero base (growth not defined). |
prev_month | string | Previous month in YYYY-MM format. |
total | integer | Total validations in the previous month. |
verified_volume | number | Verified volume in the previous month in MXN. |
total_delta_pct | number | null | Percentage change in total count vs. the previous month. `null` when the previous month had zero validations. |
volume_delta_pct | number | null | Percentage change in verified volume vs. the previous month. `null` when the previous month had zero verified volume. |
folio | string | Deterministic statement folio for the month, identical to the value returned in the `X-Finance-Folio` header of the export endpoint. |
Used in operations
GET /v1/finance/summary