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

Obtener el estado de cuenta mensual (PDF, XLSX, CSV o HTML)

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

Genera el estado de cuenta financiero del mes en cuatro formatos:

  • format=pdf (predeterminado): PDF estilo extracto bancario con resumen de portafolio, distribución de veredicto, top contrapartes y bancos, detalle diario y hasta 1,000 transacciones en el anexo.
  • format=xlsx: libro con 6 hojas (Resumen, Detalle diario, Top contrapartes, Top bancos, Veredicto, Verificaciones). La hoja Verificaciones lleva el historial completo del mes sin tope.
  • format=csv: CSV particionado en secciones [HEADER], [KPIS], [TRANSACTIONS] y [TOTALS]. El orden de las secciones es estable, que es lo que permite parsear por marcador.
  • format=html: mismo contenido del PDF, servido inline para impresión desde el navegador.

Todas las variantes devuelven la cabecera X-Finance-Folio con el folio determinístico del periodo.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
formatquerystringopcional

Formato de archivo solicitado para descarga. Aceptados: pdf, xlsx, csv o html.

Predeterminado: pdf

p. ej. pdf
month*querystringobligatorio

Mes del estado de cuenta 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/statement' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Códigos de respuestaGET /v1/finance/statement
CódigoClaseDescripciónCuerpo
2002xxStream del estado de cuenta en el formato solicitado.Cuerpo sin schema
4004xxParámetro month inválido o ausenteErrorResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
5005xxpdf_render_failed, xlsx_render_failed o csv_stream_failed: Reintentar con otro formato.ErrorResponse
Cabeceras de respuesta200
CabeceraTipoDescripción
Cache-ControlstringDeshabilita el almacenamiento en caché por parte de intermediarios durante la descarga.
Content-DispositionstringNombre de archivo sugerido para la descarga.
X-Finance-FoliostringFolio determinístico del periodo. El mismo par usuario+mes produce siempre el mismo folio.
X-Frame-Optionsstring—
Errores de GET /v1/finance/statement
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