As Rotas Contábeis respondem a três perguntas operacionais:Documentation Index
Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
Use this file to discover all available pages before exploring further.
- Qual tipo de Transação está sendo configurado?
- Quais Contas podem participar?
- Quais lançamentos contábeis devem ser registrados quando a Transação é executada?
Como as peças se encaixam
| Peça | O que controla | Exemplo |
|---|---|---|
| Rota Contábil | A Rota em nível de Transação que agrupa as Rotas de Operação. | Pix transfer route |
| Rota de Operação | O lado da Conta e a regra de validação. | Source deve ser customer, Destination deve ser merchant |
| Regra de validação | Como o Midaz decide se uma Conta pode ser usada. | Tipo de Conta customer ou alias @treasury_main |
| Cenário contábil | Quais lançamentos de débito e crédito são registrados durante o ciclo de vida da Transação. | Direct, Two-Step, Reversal |
Escolhendo o tipo de operação
Use Source quando a regra se aplica apenas ao lado de envio
Use Source quando a regra se aplica apenas ao lado de envio
Use Source para Contas onde o valor se origina.Exemplo: uma Conta de cliente pode enviar fundos em um fluxo de pagamento.
Use Destination quando a regra se aplica apenas ao lado de recebimento
Use Destination quando a regra se aplica apenas ao lado de recebimento
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 regra vale para os dois lados
Use Bidirectional quando a mesma regra vale para os dois lados
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ção | Quando usar | Exemplo |
|---|---|---|
| Tipo de Conta | Qualquer Conta de uma classe deve ser válida. | Qualquer Conta customer pode enviar. |
| Alias | Apenas uma Conta exata deve ser válida. | Somente @treasury_main pode enviar. |
| Sem validação | Você quer, propositalmente, não validar a Conta nesse nível da Rota. | Raro; use com cuidado. |
Padrões comuns de Rota
Cliente para comerciante
Use Rotas Source e Destination separadas quando cada lado tem um papel diferente.| Rota de Operação | Validação |
|---|---|
| Source | Tipo de Conta customer |
| Destination | Tipo 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ção | Validação |
|---|---|
| Bidirectional | Tipo 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ção | Validação |
|---|---|
| Source | Tipo de Conta customer |
| Destination | Alias @fee_revenue |
Cenários contábeis
| Cenário | Quando usar | O que o usuário configura |
|---|---|---|
| Direct Transaction | O movimento é executado em uma única etapa. | Lançamentos de débito e crédito para registro imediato. |
| Two-Step Transaction | O movimento tem fases de hold, commit e cancel. | Lançamentos para reserva, confirmação e cancelamento. |
| Reversal | Uma Transação concluída pode precisar ser estornada. | Lançamentos de débito e crédito para o evento de estorno. |
Próximos passos
Depois que o modelo da Rota estiver claro, crie-a em Criar uma Rota Contábil.
Criar Rota de Transação
Crie a Rota em nível de Transação via API.
Criar Rota de Operação
Crie regras de roteamento em nível de Rota de Operação via API.