> ## 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.

# Criando uma Rota Contábil

> Monte uma Rota Contábil pelo assistente guiado para definir como Transações e operações são roteadas.

As Rotas Contábeis são criadas por meio de um assistente guiado de 3 etapas que conduz você pela definição da Rota de Transação, configuração das Rotas de Operação com cenários contábeis e revisão da configuração final.

## Antes de começar

***

Crie os Tipos de Conta e as Contas que a rota irá validar. Se você ainda está decidindo entre cenários Origem, Destino, Bidirecional, validação de Tipo de Conta, validação de alias, Direta, Em Duas Etapas ou Estorno, leia primeiro [Regras contábeis](/pt/lerian-console/midaz-console/mc-accounting).

<Warning>
  Se **Validar Rotas** estiver habilitado para o Ledger, as transações precisam corresponder a uma rota existente. Não habilite a validação de rotas até que as Rotas Contábeis necessárias estejam prontas.
</Warning>

## Etapa 1: Informações básicas

***

<Steps>
  <Step>
    Na página **Rotas Contábeis**, clique em **Nova Rota**.
  </Step>

  <Step>
    O assistente de criação abre na **Etapa 1 — Informações básicas**.
  </Step>

  <Step>
    Preencha as informações básicas:

    * **Título** (obrigatório): um nome descritivo para esta Rota de Transação. Este campo precisa ser preenchido para continuar.
    * **Descrição** (opcional): uma descrição da finalidade da rota. Se deixada em branco, ela é totalmente omitida — nenhuma descrição vazia é armazenada.
  </Step>

  <Step>
    Clique em **Próximo** para avançar para a Etapa 2.
  </Step>
</Steps>

## Etapa 2: Rotas de Operação

***

Nesta etapa, você adiciona e configura as Rotas de Operação que definem como as contas são validadas e como os lançamentos contábeis são registrados.

<Note>
  Uma Rota de Operação **Bidirecional** atua como origem e destino: quando você cria uma transação depois, as rotas bidirecionais são consideradas em **ambos** os lados, origem e destino, de modo que uma única rota pode validar as duas pontas do fluxo.
</Note>

<Steps>
  <Step>
    Clique em **Adicionar Rota de Operação** para criar seu primeiro card de Rota de Operação.
  </Step>

  <Step>
    Configure a Rota de Operação:

    * **Título** (obrigatório): um nome para esta Rota de Operação. A Rota de Operação tem um único campo de texto obrigatório — não há mais um campo de descrição separado — e você não consegue avançar para a próxima etapa enquanto ele não for preenchido.
    * **Tipo de Operação**: `Origem`, `Destino` ou `Bidirecional`.
    * **Tipo de Validação**: `Tipo de Conta`, `@Alias` ou em branco quando nenhuma validação de conta for necessária.
    * **Tipo de Conta ou Alias**: os valores de Tipo de Conta selecionados ou o alias específico da conta.
  </Step>

  <Step>
    *(Opcional)* Configure os **Cenários Contábeis** para definir como os lançamentos são registrados. Ative os cenários que você precisar:

    <Tabs>
      <Tab title="Transação Direta">
        Transação padrão em uma única etapa. Defina o **Código da Conta** e a **Descrição** para:

        * **Débito** — O código de conta debitado na execução
        * **Crédito** — O código de conta creditado na execução

        <Tip>
          Nas Transações Diretas, os lados exibidos dependem do Tipo de Operação. Rotas Origem mostram apenas débito, rotas Destino mostram apenas crédito, e rotas Bidirecionais mostram ambos. Outros cenários podem ser diferentes — consulte a aba Transação em Duas Etapas para mais detalhes.
        </Tip>
      </Tab>

      <Tab title="Transação em Duas Etapas">
        Transações com um ciclo de reserva e confirmação. Configure os lançamentos para cada fase:

        * **Hold (Reserva de Valor)** — Lançamentos quando os valores são reservados
        * **Commit (Confirmação da Reserva)** — Lançamentos quando a reserva é confirmada
        * **Cancel (Cancelamento da Reserva)** — Lançamentos se a reserva for cancelada

        Os campos de lançamento disponíveis variam conforme o Tipo de Operação:

        * **Origem** — Hold e Cancel mostram campos de débito e crédito. Commit mostra apenas débito.
        * **Destino** — Apenas a fase Commit é exibida, somente com crédito. Hold e Cancel não estão disponíveis.
        * **Bidirecional** — Todas as fases mostram campos de débito e crédito.
      </Tab>

      <Tab title="Estorno">
        Lançamentos registrados quando uma transação concluída é estornada. Defina os códigos de conta de débito e crédito e as descrições para os lançamentos de estorno.

        <Note>
          O cenário Estorno está disponível apenas para Rotas de Operação **Bidirecionais**.
        </Note>
      </Tab>
    </Tabs>
  </Step>

  <Step>
    *(Opcional)* Clique novamente em **Adicionar Rota de Operação** para adicionar mais Rotas de Operação a esta Rota Contábil.

    <Warning>
      Você precisa adicionar ao menos uma Rota de Operação de origem e uma de destino, ou ao menos uma rota bidirecional. O assistente não prossegue sem uma configuração de rota válida.
    </Warning>
  </Step>

  <Step>
    Clique em **Próximo** para avançar para a Etapa 3.
  </Step>
</Steps>

## Etapa 3: Revisão

***

<Steps>
  <Step>
    Revise a configuração completa:

    * Título e descrição da Rota de Transação
    * Cada Rota de Operação com seu tipo, regras de validação e lançamentos contábeis
    * Cenários Contábeis com lançamentos de débito e crédito por tipo de transação
  </Step>

  <Step>
    Se algo precisar ser ajustado, clique em **Anterior** para voltar.
  </Step>

  <Step>
    Clique em **Criar Rota de Transação** para criar a Rota Contábil.
  </Step>
</Steps>

## Guia de campos

***

### Informações básicas

| Campo          | O que informar                                                             | Exemplo                                            |
| -------------- | -------------------------------------------------------------------------- | -------------------------------------------------- |
| Título da Rota | Nome obrigatório da rota. Mantenha curto e específico ao fluxo de negócio. | `Pix Transfer Route`                               |
| Descrição      | Explicação opcional do que a rota valida ou registra.                      | `Handles Pix transfers between customer accounts.` |

### Rota de Operação

| Campo                   | O que informar                                                                                                                                                                    | Exemplo                               |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| Título                  | Nome obrigatório deste card de Rota de Operação. Precisa ser preenchido para avançar; não há campo de descrição separado.                                                         | `Checking account validation for Pix` |
| Tipo                    | Lado contábil ao qual esta Rota de Operação se aplica: `Origem`, `Destino` ou `Bidirecional`. Não pode ser alterado após a criação.                                               | `Bidirecional`                        |
| Tipo de Validação       | Como as contas são validadas. Use `Tipo de Conta` para classes de conta ou `@Alias` para uma conta específica. Deixe em branco apenas quando não houver necessidade de validação. | `Tipo de Conta`                       |
| Tipo de Conta ou Alias  | Tipos de Conta ou aliases aceitos por esta Rota de Operação.                                                                                                                      | `customer`                            |
| Cenários Contábeis      | Cenários de transação que esta rota deve registrar: Direta, Em Duas Etapas ou Estorno.                                                                                            | `Transação Direta`                    |
| Código da Conta         | Código contábil usado no lançamento de débito ou crédito do cenário selecionado.                                                                                                  | `1.1.1.001`                           |
| Descrição do Lançamento | Descrição em nível de lançamento exibida na configuração do cenário.                                                                                                              | `Customer checking - outbound`        |

## Exemplo rápido

***

<Accordion title="Transferência Pix com cenários Direta e Em Duas Etapas">
  **Rota de Transação**

  | Campo     | Valor                                                     |
  | --------- | --------------------------------------------------------- |
  | Título    | `Pix Transfer Route`                                      |
  | Descrição | `Handles Pix instant transfers between checking accounts` |

  **Rota de Operação 1 — Bidirecional**

  | Campo             | Valor                                 |
  | ----------------- | ------------------------------------- |
  | Título            | `Checking account validation for Pix` |
  | Tipo de Operação  | `Bidirecional`                        |
  | Tipo de Validação | `Tipo de Conta`                       |
  | Tipos de Conta    | `checking`                            |

  **Cenário Transação Direta**

  | Lado    | Código da Conta | Descrição                      |
  | ------- | --------------- | ------------------------------ |
  | Débito  | `1.1.1.001`     | `Customer checking — outbound` |
  | Crédito | `1.1.1.002`     | `Customer checking — inbound`  |

  **Transação em Duas Etapas — Hold**

  | Lado    | Código da Conta | Descrição                     |
  | ------- | --------------- | ----------------------------- |
  | Débito  | `1.1.1.001`     | `Customer checking — reserve` |
  | Crédito | `2.1.1.001`     | `Pending settlement — hold`   |

  **Transação em Duas Etapas — Commit**

  | Lado    | Código da Conta | Descrição                      |
  | ------- | --------------- | ------------------------------ |
  | Débito  | `2.1.1.001`     | `Pending settlement — release` |
  | Crédito | `1.1.1.002`     | `Customer checking — settled`  |
</Accordion>

## O que fazer em seguida

***

Após criar a rota, crie uma transação que corresponda aos mesmos Tipos de Conta, aliases e cenário em [Criando uma Transação](/pt/lerian-console/midaz-console/creating-a-transaction).

<CardGroup cols={2}>
  <Card title="Criar Rota de Transação" icon="code" href="/pt/reference/midaz/create-transaction-route">
    Crie a rota em nível de transação pela API.
  </Card>

  <Card title="Criar Rota de Operação" icon="code" href="/pt/reference/midaz/create-an-operation-route">
    Crie regras de roteamento em nível de operação pela API.
  </Card>
</CardGroup>
