Skip to main content
Este guia organiza os campos usados no ecossistema da Lerian em uma única referência. Ele apoia as equipes de engenharia que trabalham com o Midaz, seus componentes embutidos de CRM e Fees Engine, Flowker, Identity, Pix, Auth, Reporter e plugins relacionados. Este dicionário ajuda você a validar payloads, melhorar a interoperabilidade, simplificar o QA e acelerar o desenvolvimento de integrações.

​
Por que este dicionário é importante

Novos recursos, plugins e versões trazem novos campos e comportamentos. Este dicionário centraliza todas as definições, para que você veja como nossos produtos se comunicam entre si. Use-o para:
  • Criar integrações com confiança
  • Reduzir a ambiguidade entre workflows
  • Validar estruturas de payload
  • Apoiar QA, observabilidade e depuração
  • Acelerar o onboarding de novos desenvolvedores

​
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 da Lerian
Se você trabalha com um produto específico, abra a página do dicionário para essa área, listada em Estrutura do dicionário, abaixo.
Para validação rigorosa de schema, sempre consulte as especificações oficiais do 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 os formatos ISO 8601 ou RFC3339
  • UUIDs seguem o formato v4
  • Campos do Pix seguem os padrões do BACEN
  • Campos de workflow seguem a semântica de runtime e criação do Flowker
  • Campos do Fees Engine refletem o modelo v2 mais recente
  • Metadados são sempre um par flexível de chave-valor
Se sua integração usa operações sensíveis como Pix, Identity ou Fees Engine, verifique o comportamento e os formatos aceitos diretamente nas APIs do produto. Alguns campos se comportam de forma diferente dependendo do contexto de execução.

​
Estrutura do dicionário

O dicionário tem as seguintes categorias:

Campos principais

Campos essenciais compartilhados entre todas as APIs da 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 dados 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 webhook e monitoramento de saúde do sistema.

Workflows e relatórios

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

Tracer

Campos para validação de transações, regras, limites de gastos e respostas de decisão.

Operações Pix

Campos para resolução de disputas do Pix: reivindicações, relatos de infração, solicitações de devolução e marcadores de fraude.

Operações de ledger

Campos para saldos, rotas de transação, rotas de operação e índices de metadados.