FinanceSummaryResponse
Response from `GET /v1/finance/summary` with the requested month's indicators in `data.attributes`.
Properties
| Field | Type | Description |
|---|---|---|
data | object | Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`). |
type | string | JSON:API resource type. Always `finance_summary`. |
attributes | object | Account financial indicators for a calendar month, with aggregates, breakdowns, 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 | Start of the month in UTC, in `YYYY-MM-DD HH:MM:SS` format. |
to_utc | string | End of the month in UTC (exclusive), in `YYYY-MM-DD HH:MM:SS` format. |
counts | object | Validation counts by verdict, plus records withdrawn through soft deletion during the period (informational). |
total | integer | Number of validations in the period, including those with `pending` status. |
valid | integer | Validations with `valid` verdict in the period. |
invalid | integer | Validations with `invalid` verdict in the period. |
not_found | integer | Validations with `not_found` verdict in the period. |
cep_unavailable | integer | Validations with `cep_unavailable` verdict in the period. |
returned | integer | Validations whose operation was settled and later returned in the period. |
error | integer | Validations that ended in a technical error. |
pending | integer | Validations still in progress that had not reached a terminal status at the end of the period. |
deleted | integer | Validations withdrawn through soft deletion during the period. |
amounts | object | Monetary aggregates for the period. `verified_volume` sums only validations with `valid` result. |
total_volume | number | Summed amount in MXN of every validation in the period. |
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 `counts.total`, 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 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 | Number of 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. |
meta | object | Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC. |
version | string | API version that processed the request. |
api_version | string | API route prefix version (e.g. `v1`). |
request_id | string | Unique request identifier (hex). |
datetime | object | Companion descriptor present in the `meta` block of every response (and in the `meta` of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec. |
timezone* | string | Always `UTC`: The canonical timezone for every datetime field in the body. |
format* | string | Always `ISO 8601`: Explicit `Z` suffix on every datetime. |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
Used in operations
GET /v1/finance/summary