Saltar al contenido principal
Esta guía organiza todos los campos utilizados en el ecosistema de Lerian en una referencia única, confiable y fácil de navegar. Apoya a los socios y equipos de desarrollo que necesitan claridad y consistencia en Midaz, Flowker, Identity, CRM, Fee, PIX, Auth, Reporter y plugins relacionados. Este diccionario te ayuda a validar payloads, mejorar la interoperabilidad, optimizar el QA y acelerar el desarrollo de integraciones.

​
Por qué importa este diccionario

Las APIs evolucionan rápidamente. Las nuevas características, plugins y versiones traen nuevos campos y comportamientos. Este diccionario centraliza todas las definiciones, facilitando la comprensión de cómo se comunican nuestros productos entre sí. Úsalo para:
  • Construir integraciones con confianza
  • Reducir la ambigüedad en los flujos de trabajo
  • Validar estructuras de payload
  • Apoyar QA, observabilidad y depuración
  • Acelerar la incorporación de nuevos desarrolladores y socios

​
Cómo usar esta página

Cada sección agrupa los campos por categorías semánticas. Cada campo incluye:
  • Nombre del campo
  • Descripción
  • Dónde se usa en los productos de Lerian
Si estás trabajando con un producto específico, desplázate hacia abajo para encontrar subsecciones dedicadas a Flowker, PIX, Identity, Fees Engine y Reporter.
Para una validación estricta de esquemas, siempre verifica las especificaciones oficiales de OpenAPI. Esos archivos reflejan la estructura exacta requerida por cada endpoint.

​
Antes de explorar

Este diccionario sigue convenciones consistentes en todos los productos.
  • Las fechas usan formatos ISO 8601 o RFC3339
  • Los UUIDs siguen el formato v4
  • Los campos de PIX siguen los estándares de BACEN
  • Los campos de flujo de trabajo siguen la semántica de runtime y autoría de Flowker
  • Los campos de Fees Engine reflejan el último modelo v2
  • Los metadatos son siempre clave-valor flexible
Si tu integración usa operaciones sensibles como PIX, Identity o Fees Engine, verifica el comportamiento y los formatos aceptados directamente en las APIs del producto. Algunos campos se comportan de manera diferente dependiendo del contexto de ejecución.

​
Estructura del diccionario

El diccionario está dividido en las siguientes categorías:

Campos principales

Campos esenciales compartidos en todas las APIs de Lerian, incluyendo identificadores, marcas de tiempo, paginación y metadatos de auditoría.

Personas y organizaciones

Campos que describen individuos, empresas, usuarios, grupos y estructuras organizacionales.

Datos financieros

Campos relacionados con detalles bancarios, operaciones PIX, transacciones financieras, códigos QR y límites operacionales.

Autenticación y seguridad

Campos utilizados para autenticación, autorización, flujos OAuth2, validación de webhooks y monitoreo de salud del sistema.

Flujos de trabajo y reportes

Campos relacionados con orquestación de flujos de trabajo (Flowker), reportes (Reporter), cálculos de tarifas y manejo de errores.

Tracer

Campos para validación de transacciones, reglas, límites de gasto y respuestas de decisión.

Operaciones PIX

Campos para resolución de disputas PIX — reclamos, reportes de infracción, solicitudes de reembolso y marcadores de fraude.

Operaciones de ledger

Campos para saldos, rutas de transacción, rutas de operación e índices de metadatos.