Skip to main content
Este guia organiza todos os campos usados no ecossistema Lerian em uma referência única, confiável e fácil de navegar. Ele apoia parceiros e equipes de desenvolvimento que precisam de clareza e consistência entre Midaz, Flowker, Identity, CRM, Fee, PIX, Auth, Reporter e plugins relacionados. Este dicionário ajuda você a validar payloads, melhorar a interoperabilidade, otimizar o QA e acelerar o desenvolvimento de integrações.

​
Por que este dicionário importa

APIs evoluem rapidamente. Novos recursos, plugins e versões trazem novos campos e comportamentos. Este dicionário centraliza todas as definições, facilitando o entendimento de como nossos produtos se comunicam entre si. Use-o para:
  • Construir integrações com confiança
  • Reduzir ambiguidade entre fluxos de trabalho
  • Validar estruturas de payload
  • Apoiar QA, observabilidade e debugging
  • Acelerar o onboarding de novos desenvolvedores e parceiros

​
Como usar esta página

Cada seção agrupa campos por categorias semânticas. Cada campo inclui:
  • Nome do campo
  • Descrição
  • Onde é usado nos produtos Lerian
Se você está trabalhando com um produto específico, role para baixo para encontrar subseções dedicadas para Flowker, PIX, Identity, Fee Engine e Reporter.
Para validação estrita de schema, sempre verifique as especificações oficiais OpenAPI. Esses arquivos refletem a estrutura exata exigida por cada endpoint.

​
Antes de explorar

Este dicionário segue convenções consistentes em todos os produtos.
  • Datas usam formatos ISO 8601 ou RFC3339
  • UUIDs seguem formatação v4
  • Campos PIX seguem padrões do BACEN
  • Campos de workflow seguem a semântica de runtime e autoria do Flowker
  • Campos do Fee Engine refletem o modelo v2 mais recente
  • Metadata é sempre um par chave-valor flexível
Se sua integração usa operações sensíveis como PIX, Identity ou Fee Engine, verifique o comportamento e formatos aceitos diretamente nas APIs do produto. Alguns campos se comportam diferentemente dependendo do contexto de execução.

​
Estrutura do dicionário

O dicionário está dividido nas seguintes categorias:

Campos principais

Campos essenciais compartilhados em todas as APIs Lerian, incluindo identificadores, timestamps, paginação e metadados de auditoria.

Pessoas e organizações

Campos que descrevem indivíduos, empresas, usuários, grupos e estruturas organizacionais.

Dados financeiros

Campos relacionados a detalhes bancários, operações PIX, transações financeiras, QR Codes e limites operacionais.

Autenticação e segurança

Campos usados para autenticação, autorização, fluxos OAuth2, validação de webhooks e monitoramento de saúde do sistema.

Workflows e relatórios

Campos relacionados à orquestração de workflows (Flowker), relatórios (Reporter), cálculos de tarifas e tratamento de erros.