Skip to main content
Use o Midaz Module para gerenciar Rotas Contábeis, a configuração de roteamento de transações no Midaz. Um assistente guiado leva você por três etapas: definir a rota de transação, adicionar as rotas de operação e revisar a configuração. Uma Rota Contábil define toda a lógica de roteamento de uma transação. Ela tem três partes:
  • Os metadados no nível de transação são o título e a descrição.
  • As rotas de operação definem quais contas participam e em qual direção.
  • Os cenários contábeis controlam como o ledger registra os lançamentos para cada tipo de transação.

Regras contábeis

Comece aqui se você precisar decidir entre usar cenários de Origem, Destino, Bidirecional, validação de Tipo de Conta, validação de alias, Direct, Duas Etapas ou Estorno.
Para detalhes técnicos sobre as entidades subjacentes, consulte a página Entidades de Rotas Contábeis.

​
Conceitos-chave

​
Tipos de rota de operação

Cada rota de operação dentro de uma Rota Contábil tem um de três tipos:
  • Origem: define as regras de validação para as contas de onde os fundos se originam (lado do débito)
  • Destino: define as regras de validação para as contas que recebem os fundos (lado do crédito)
  • Bidirecional: se aplica aos dois lados da transação, como origem e destino ao mesmo tempo
Uma Rota Contábil válida exige pelo menos uma rota de operação de origem e uma de destino, ou pelo menos uma rota bidirecional.
Uma rota bidirecional funciona como origem e como destino ao mesmo tempo. O Midaz a corresponde dos dois lados quando você cria uma transação. Ela aparece nas duas listas de rotas, a de origem e a de destino, então uma única rota pode cobrir as duas pontas de um fluxo.

​
Tipos de validação

Cada rota de operação valida contas por um de dois métodos:
  • Tipo de Conta: valida em relação a uma ou mais categorias de tipo de conta (por exemplo, checking, savings). Use quando qualquer conta de um determinado tipo for válida.
  • @Alias: valida em relação a um alias de conta específico (por exemplo, @treasury_main). Use quando você precisar mirar em uma conta exata.

​
Cenários contábeis

Os cenários contábeis definem como o ledger registra os lançamentos de débito e de crédito para cada rota de operação. Você pode configurar lançamentos para cinco tipos de transação:
  • Transação Direct: transação padrão, de uma única etapa. Defina os códigos e as descrições das contas de débito e de crédito para liquidação imediata.
  • Transação em Duas Etapas: transações que passam por um ciclo de hold seguido de commit. Configure lançamentos para:
    • Hold (Reserva de Valor): lançamentos registrados quando o ledger reserva os fundos
    • Commit (Confirmação da Reserva): lançamentos registrados quando você confirma a reserva
    • Cancel (Cancelamento da Reserva): lançamentos registrados quando você cancela a reserva
  • Estorno: lançamentos registrados quando você estorna uma transação concluída
  • Overdraft: lançamentos registrados quando um débito excede os fundos disponíveis da conta e recorre a uma linha de overdraft. Disponível para rotas de operação Origem e Bidirecional, e exige lançamentos de débito e de crédito em todos os tipos de rota compatíveis. Quando você habilita esse cenário, o Midaz também habilita o cenário Direct.
  • Block/Unblock: lançamentos registrados quando você retém e libera fundos no saldo da conta. O rótulo da aba do cenário é Block. Disponível para todos os tipos de rota de operação.
Cada lançamento de cenário inclui um Código da Conta e uma Descrição para os lados de débito e de crédito.
Os lados de lançamento disponíveis dependem do tipo de rota de operação e da fase do cenário. A regra geral é:
  • Origem: lançamentos de débito em Direct, Hold, Commit e Cancel. Lançamentos de crédito apenas em Hold e Cancel.
  • Destino: apenas lançamentos de crédito, em Direct e Commit. Hold e Cancel não estão disponíveis.
  • Bidirecional: lançamentos de débito e de crédito em todas as fases, incluindo Estorno.
  • Block/Unblock: disponível para todos os tipos de rota. Ele retém e libera fundos no saldo da conta.

​
Acessando a página de Rotas Contábeis

O menu Rotas Contábeis aparece apenas quando você habilita a configuração Validar Rotas para o Ledger atual. Para habilitá-la, abra os detalhes do Ledger, vá até a aba Configurações e ative o toggle Validar Rotas.
Validação de Rotas Contábeis desabilitada. Se você abrir esta página pela URL enquanto Validar Rotas estiver desligado, um banner aparece no topo da tela. O Ledger ainda não processa as rotas contábeis registradas aqui. Os lançamentos apenas seguem essas regras depois que você habilita Validar Rotas nas configurações do Ledger. Você ainda pode ver e editar as rotas, mas elas não têm efeito até você habilitar a validação.
Para abrir a página Rotas Contábeis, selecione Rotas Contábeis na seção Contabilidade do menu lateral esquerdo. A página Rotas Contábeis exibe as suas rotas do Ledger atual como uma lista em card-acordeão. Cada rota de transação é um card recolhível. O card mostra o título, o ID da rota de transação e um selo com a contagem de operações. Expanda um card para ver as rotas de operação dele. Cada uma mostra o ID, o título, o código e o tipo de operação. O Console usa cores para os tipos de operação: origem em vermelho, destino em verde e bidirecional em cinza. Uma rota sem rotas de operação aparece como um card estático (não expansível).

​
Ações disponíveis

Na página Rotas Contábeis, você pode:

Criar uma Rota Contábil

Defina uma nova rota de transação com rotas de operação e cenários contábeis.

Editar uma Rota Contábil

Modifique uma rota contábil existente e as rotas de operação dela.

​
Casos de uso comuns

Crie uma Rota Contábil com uma rota de operação bidirecional que valida os tipos de conta checking e savings. Habilite cenários de Transação Direct com os códigos de plano de contas adequados para os lançamentos de liquidação do Pix.
Crie uma Rota Contábil com rotas de origem e de destino separadas. Habilite cenários de Transação em Duas Etapas para registrar de forma independente os lançamentos de hold (reserva), commit (confirmação) e, opcionalmente, cancel (cancelamento).
Crie uma Rota Contábil com uma rota de operação bidirecional que usa validação por alias (@treasury_main). Habilite os cenários de Transação Direct e de Estorno para tratar as movimentações padrão e os estornos delas. Os lançamentos de Estorno exigem uma rota bidirecional.

​
Boas práticas

1

Use títulos descritivos

Dê nomes claros às suas Rotas Contábeis para indicar o tipo de transação que elas tratam (por exemplo, Pix Transfer Route em vez de Route 1).
2

Escolha o tipo de operação certo

Use Bidirecional quando as mesmas regras de validação se aplicarem aos dois lados. Use rotas de Origem e de Destino separadas quando cada lado tiver requisitos de conta diferentes.
3

Configure os cenários contábeis desde o início

Defina os lançamentos do plano de contas durante a criação da rota. Isso garante que as transações processadas pela rota produzam registros contábeis corretos desde o início.
4

Revise antes de confirmar

O assistente inclui uma etapa de revisão. Use-a para verificar todas as rotas de operação, as regras de validação e os lançamentos contábeis antes de criar a rota.