GET https://api.veriko.mx/v1/finance/statement

Estado de cuenta mensual (PDF / XLSX / CSV / HTML)

Audiencia
public
Autenticación
API key
Permiso
finance:generate_self
Guía de uso →

Estado de cuenta financiero del mes en cuatro formatos:

  • format=pdf (predeterminado, application/pdf): PDF estilo extracto bancario con encabezado y pie de página repetidos ("Página X de Y"), resumen de portafolio, distribución de veredicto, top contrapartes y bancos, detalle diario y hasta 1000 transacciones en el anexo.
  • format=xlsx (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet): libro con 6 hojas (Resumen, Detalle diario, Top contrapartes, Top bancos, Veredicto, Verificaciones). La hoja Verificaciones lleva el ledger completo del mes sin tope.
  • format=csv (text/csv; charset=utf-8): CSV con BOM UTF-8 particionado en secciones [HEADER], [KPIS], [TRANSACTIONS] y [TOTALS]. Mantén el orden si parseas por marcador.
  • format=html (text/html; charset=utf-8): mismo contenido del PDF, servido inline para impresión desde el navegador.

Todas las variantes devuelven X-Finance-Folio con el folio determinístico del periodo (SHA1(user_id|YYYY-MM|brand_slug)[:12] en mayúsculas). Las descargas incluyen X-Frame-Options: DENY y Cache-Control: no-cache, no-store. Alcance: propio por defecto. Administradores con finance:generate_all pueden consultar otro usuario vía ?user_id=<uuid>. Acepta cookie o API key. Los KPIs renderizados en el PDF/XLSX vienen del mismo cómputo que GET /v1/finance/summary; para los CEPs anexos en un ZIP separado usa GET /v1/finance/ceps.

Parámetros
Parámetro Ubicación Tipo Obligatorio Descripción
format query string opcional

Formato de salida.

Predeterminado: pdf

month * query string obligatorio

Mes del estado de cuenta en formato `YYYY-MM`.

user_id query string (uuid) opcional

Solo para administradores con `finance:generate_all`. UUID del usuario a consultar.

Petición
curl -X GET 'https://api.veriko.mx/v1/finance/statement' \
  -H 'Authorization: Bearer mxcep_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Códigos de respuesta GET /v1/finance/statement
Código Clase Descripción Cuerpo
200 2xx Stream del estado de cuenta en el formato solicitado. Sin cuerpo
400 4xx Parámetro `month` inválido o ausente ErrorResponse
401 4xx Se requiere autenticación o las credenciales son inválidas ErrorResponse
403 4xx Permisos insuficientes ErrorResponse
500 5xx `pdf_render_failed` cuando dompdf truena (OOM, fuente faltante). `xlsx_render_failed` cuando phpspreadsheet truena. `csv_stream_failed` cuando `php://output` no se puede abrir. Para PDF/XLSX, intentar otro formato. ErrorResponse
Cabeceras de respuesta 200
Cabecera Tipo Descripción
Cache-Control string Disables intermediary caching de la descarga (folio determinístico, pero contenido sensible).
Content-Disposition string Nombre de archivo sugerido para la descarga.
X-Finance-Folio string Folio determinístico del periodo (12 hex en mayúsculas). El mismo par usuario+mes produce siempre el mismo folio.
X-Frame-Options string Defense anti-DoS: descargas no embeben en iframe.
Errores de GET /v1/finance/statement
Código Clave Detalle
400 invalid_month

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

Envelope
meta.request_id
d5e6f7a8b9c1
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0