Skip to main content
Esta guía organiza los campos usados en todo el ecosistema de Lerian en una única referencia. Ayuda a los equipos de ingeniería que trabajan con Midaz, sus componentes integrados de CRM y Fees Engine, Flowker, Identity, Pix, Auth, Reporter y los plugins relacionados. Este diccionario te ayuda a validar payloads, mejorar la interoperabilidad, simplificar el QA y acelerar el desarrollo de integraciones.

​
Por qué importa este diccionario

Las nuevas funcionalidades, plugins y versiones traen nuevos campos y comportamientos. Este diccionario centraliza todas las definiciones, para que puedas ver cómo se comunican nuestros productos entre sí. Úsalo para:
  • Construir integraciones con confianza
  • Reducir la ambigüedad entre workflows
  • Validar estructuras de payload
  • Dar soporte a QA, observabilidad y debugging
  • Acelerar la incorporación de nuevos desarrolladores

​
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 trabajas con un producto específico, abre la página del diccionario correspondiente a esa área, listada más abajo en Estructura del diccionario.
Para una validación estricta del esquema, siempre consulta las especificaciones oficiales de OpenAPI. Esos archivos reflejan la estructura exacta que requiere cada endpoint.

​
Antes de explorar

Este diccionario sigue convenciones consistentes en todos los productos.
  • Las fechas usan los formatos ISO 8601 o RFC3339
  • Los UUID siguen el formato v4
  • Los campos de Pix siguen los estándares de BACEN
  • Los campos de workflow siguen la semántica de runtime y creación de Flowker
  • Los campos de Fees Engine reflejan el último modelo v2
  • Los metadatos siempre son un par 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 forma diferente según el contexto de ejecución.

​
Estructura del diccionario

El diccionario tiene las siguientes categorías:

Campos principales

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

Personas y organizaciones

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

Datos financieros

Campos relacionados con datos bancarios, operaciones de Pix, transacciones financieras, códigos QR y límites operativos.

Autenticación y seguridad

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

Workflows y reportes

Campos relacionados con la orquestación de workflows (Flowker), los reportes (Reporter), el cálculo de comisiones y el manejo de errores.

Tracer

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

Operaciones de Pix

Campos para la resolución de disputas de Pix: reclamos, reportes de infracción, solicitudes de devolución y marcadores de fraude.

Operaciones del ledger

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