GEThttps://api.veriko.mx/v1/finance/by-bank

Bank summary (CSV / XLSX / PDF / preview)

Audience
public
Auth
API key
Permission
finance:generate_self
How-to guide →

Groups the month's verifications by receiving bank (banxico_code), with totals, valid count, success rate and total amount. It contains 6 columns:

  • Clave Banxico.
  • Banco.
  • Verificaciones.
  • Válidas.
  • Tasa éxito (%).
  • Monto total.

The summary can be requested in any of these formats: format=csv (default), format=xlsx, format=pdf (maximum 1000 rows).
format=preview is also available, to get the first 20 rows as JSON.

For more about exports see exports and formats.

Parameters
ParameterInTypeRequiredDescription
formatquerystringoptional

Requested file format for the download. Accepted: csv, xlsx, pdf or preview.

Default: csv

e.g. csv
limitqueryintegeroptional

Trims the number of rows when the output is csv or xlsx. It does not affect the PDF, which carries its own 1000-row cap.

e.g. 500
month*querystringrequired

Month to report in YYYY-MM format.

e.g. 2026-04
user_idquerystring (uuid)optional

Administrators only — UUID of the user to query.

e.g. f47ac10b-58cc-4372-a567-0e02b2c3d479
Request
curl -X GET 'https://api.veriko.mx/v1/finance/by-bank' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200FinancePreviewResponse — CSV/XLSX/PDF stream, or JSON envelope in preview mode.
FieldTypeDescription
dataobject

Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with type, id, attributes).

typestring

JSON:API resource type. Always finance_preview.

e.g. finance_preview
attributesobject

Report preview fields.

reportstring

Report type — monthly: Monthly statement; counterparties: Top counterparties; by-bank: Bank breakdown; accounting: Accounting ledger.

e.g. monthly
monthstring

Report month in YYYY-MM format.

e.g. 2026-04
headersarray

CSV column names, in the same order as the values in rows.

e.g. ["Fecha","Folio plataforma","Tipo","Clave de rastreo","Fecha operación","Monto","Banco emisor","CLABE emisora","Banco receptor","CLABE receptora","Beneficiario","Veredicto Banxico","CEP disponible","Folio CEP","Tiempo (ms)"]
rowsarray (items: ?–20)

First 20 data rows of the report (maximum).

e.g. [["2026-04-15 10:32:00","c3d4e5f6-a7b8-9012-cdef-123456789012","direct","MXBA20260415001234","2026-04-15","15000.50","BBVA MEXICO","012180001234567891","BANORTE","072180009876543210","Comercializadora Ejemplo SA de CV","valid","Sí","","412"]]
metaobject

Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.

versionstring

API version that processed the request.

e.g. 1.47.0
api_versionstring

API route prefix version (e.g. v1).

e.g. v1
request_idstring

Unique request identifier (hex).

e.g. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

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.

e.g. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Always UTC: The canonical timezone for every datetime field in the body.

e.g. UTC
format*string

Always ISO 8601: Explicit Z suffix on every datetime.

e.g. ISO 8601
linksobject

Pagination or related links, present only when the endpoint returns a paginated collection.

Response status codesGET /v1/finance/by-bank
StatusClassDescriptionBody
2002xxCSV/XLSX/PDF stream, or JSON envelope in preview mode.FinancePreviewResponse
4004xxInvalid or missing month parameterErrorResponse
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
5005xxpdf_render_failed: PDF renderer crashed. Try CSV or XLSX.ErrorResponse
Response headers200
HeaderTypeDescription
Cache-ControlstringDisables intermediary caching of the download (does not apply to preview mode).
Content-DispositionstringSuggested filename (does not apply in preview mode).
Errors from GET /v1/finance/by-bank
StatusCodeExample
400invalid_month

'month' is required and must be YYYY-MM.

Envelope
meta.request_id
d5e6f7a8b9c11c9b8a7f6e5d
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d