Pular para o conteúdo principal
A seção Contábil é onde você define as regras que toda Transação precisa seguir antes de impactar o Ledger. Isso é feito por meio das Rotas Contábeis. Uma Rota Contábil é uma regra nomeada e reutilizável para um tipo específico de Transação (por exemplo, transferência Pix, compra com cartão ou cobrança de taxa) que responde a três perguntas operacionais:
  • Quais Contas são permitidas no lado de origem?
  • Quais Contas são permitidas no lado de destino?
  • Quais lançamentos de débito e crédito devem ser registrados quando a Transação é executada?
Exemplo. Uma rota Pix transfer pode exigir que a origem seja uma Conta do tipo customer e o destino uma Conta do tipo merchant e, em seguida, registrar um lançamento direto de débito e crédito entre as duas. Quando alguém cria uma transação Pix no Midaz, é a rota que valida as Contas e grava os lançamentos. Configure as Rotas Contábeis depois de ter as Contas principais e os Tipos de Conta já definidos — as rotas são mais fáceis de modelar quando você já sabe quais Contas representam clientes, treasury, fees, settlement, revenues e expenses.

Como as peças se encaixam


PeçaO que controlaExemplo
Rota ContábilA Rota em nível de Transação que agrupa as Rotas de Operação.Pix transfer route
Rota de OperaçãoO lado da Conta e a regra de validação.Source deve ser customer, Destination deve ser merchant
Regra de validaçãoComo o Midaz decide se uma Conta pode ser usada.Tipo de Conta customer ou alias @treasury_main
Cenário contábilQuais lançamentos de débito e crédito são registrados durante o ciclo de vida da Transação.Direct, Two-Step, Reversal, Overdraft

Escolhendo o tipo de operação


Use Source para Contas onde o valor se origina.Exemplo: uma Conta de cliente pode enviar fundos em um fluxo de pagamento.
Use Destination para Contas onde o valor chega.Exemplo: uma Conta de merchant pode receber fundos em um fluxo de pagamento.
Use Bidirectional quando a mesma classe de Conta pode enviar e receber.Exemplo: Contas checking podem transferir valor para outras Contas checking.
Uma Rota precisa ter pelo menos uma Rota de Operação Source e uma Destination, ou uma Rota de Operação Bidirectional.

Escolhendo a regra de validação


Tipo de validaçãoQuando usarExemplo
Tipo de ContaQualquer Conta de uma classe deve ser válida.Qualquer Conta customer pode enviar.
AliasApenas uma Conta exata deve ser válida.Somente @treasury_main pode enviar.
Sem validaçãoVocê quer, propositalmente, não validar a Conta nesse nível da Rota.Raro; use com cuidado.
Use validação por Tipo de Conta para fluxos escaláveis. Use validação por alias para Contas operacionais fixas, como treasury, fee, settlement ou suspense.

Padrões comuns de Rota


Cliente para comerciante

Use Rotas Source e Destination separadas quando cada lado tem um papel diferente.
Rota de OperaçãoValidação
SourceTipo de Conta customer
DestinationTipo de Conta merchant

Transferência peer-to-peer

Use uma Rota Bidirectional quando o mesmo Tipo de Conta pode ser origem e destino.
Rota de OperaçãoValidação
BidirectionalTipo de Conta customer

Cobrança de taxas

Use uma Rota Destination com validação por alias quando as taxas precisam sempre cair em uma única Conta operacional.
Rota de OperaçãoValidação
SourceTipo de Conta customer
DestinationAlias @fee_revenue

Cenários contábeis


CenárioQuando usarO que o usuário configura
Direct TransactionO movimento é executado em uma única etapa.Lançamentos de débito e crédito para registro imediato.
Two-Step TransactionO movimento tem fases de hold, commit e cancel.Lançamentos para reserva, confirmação e cancelamento.
ReversalUma Transação concluída pode precisar ser estornada.Lançamentos de débito e crédito para o evento de estorno.
OverdraftUm débito pode exceder os fundos disponíveis da Conta, usando uma linha de cheque especial.Lançamentos de débito e crédito para o uso do overdraft e a posterior quitação.
Não habilite a validação de Rotas nas configurações do Ledger até que as Rotas necessárias existam. Se a validação de Rotas estiver habilitada sem Rotas correspondentes, as Transações vão falhar na validação.

Páginas disponíveis


Configurando a contabilidade na Console

Um guia passo a passo, centrado na Console, para construir seu modelo contábil — do plano de contas até um pagamento Pix funcionando, sem chamadas de API.

Gerenciar Rotas Contábeis

Configure Rotas de Transação com Rotas de Operação e cenários contábeis em um assistente unificado.