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

# Bank Transfer no Lerian Console

> Use o plugin Bank Transfer no Lerian Console via JD SPB: saúde no dashboard, lista de transferências, fila de conciliação, operações TED IN, webhooks, configurações e rotas contábeis.

O plugin **Bank Transfer** no Midaz Module permite iniciar, acompanhar e conciliar transferências bancárias pela integração **JD SPB**, direto do Lerian Console. Em um só lugar, você pode monitorar a saúde das transferências, operar fluxos TED, investigar falhas e configurar a integração.

## O que o Bank Transfer cobre

***

O plugin trata três tipos de transferência, cada um com um fluxo diferente no Console:

* **TED Out**: transferências TED de saída para outra instituição. Você as cria na página **Nova Transferência**.
* **TED In**: transferências TED de entrada recebidas da JD. Elas aparecem na lista de transferências. Não há etapa de criação manual.
* **P2P**: transferências entre duas contas da sua própria instituição. Você as cria na página **Nova Transferência**.

> [!NOTE]
>
> A página **Nova Transferência** não pede um tipo. O plugin cria uma P2P quando o ISPB do destinatário é o ISPB da sua instituição, e uma TED Out para qualquer outro ISPB.

## Ativando o plugin

***

O Bank Transfer é um plugin opcional. Habilite-o em **Configurações do Midaz → Plugins** antes de usá-lo.

> [card] [Gerenciando plugins](https://docs.lerian.studio/pt/platform/console/mc-console-plugins.md)
>
> Saiba como habilitar, desabilitar e configurar plugins no Midaz Module.

Depois de habilitado, a seção **Transferência Bancária** aparece no grupo **Plugins** da barra lateral esquerda com sete páginas:

* **Dashboard**: indicador de saúde, KPIs, volume de transferências por tipo e atividade recente.
* **Transferências**: as transferências do ledger selecionado, com filtros e exportação CSV.
* **Conciliação**: transferências cujo resultado precisa de conciliação, com concentração de falhas.
* **Operações TED IN**: coletar, reprocessar e retomar o poller do TED IN e revisar lacunas de conciliação, mensagens retidas e créditos não entregáveis.
* **Webhooks**: registros de webhook e entregas com falha.
* **Configurações**: horário de funcionamento, limites de uso e política de tarifas.
* **Rotas Contábeis**: prontidão do roteamento do ledger e os vínculos que ligam cada organização, ledger e tipo de transferência às rotas contábeis do Midaz.

> [!NOTE]
>
> Seu ambiente também controla a disponibilidade: além do toggle **Configurações → Plugins** dentro do Console, um flag de plugin em tempo de execução (`NEXT_PUBLIC_BANK_TRANSFER_ENABLED`) controla o plugin. O flag fica desligado por padrão. O Bank Transfer fica visível apenas quando o administrador define o flag como `true` para o seu ambiente. O Console lê o flag em tempo de execução, então você define a variável de ambiente e reinicia o container do Console sem rebuild. Se o card **Transferência Bancária (TED JD)** não aparecer em **Configurações → Plugins**, o flag está desligado para o seu ambiente. Veja [Lerian Console via Helm](https://github.com/LerianStudio/helm/tree/main/charts/product-console).

Cada tela do Bank Transfer precisa da permissão `bank-transfer`: `get` para vê-la, `post` para agir nela, `patch` para alterar as configurações e o documento de roteamento, e `delete` para excluir um webhook. A página **Nova Transferência** precisa de `post` para abrir.

## Páginas disponíveis

***

> [card] [Dashboard](https://docs.lerian.studio/pt/interfaces/ted-jd/console/bt-managing-dashboard.md)
>
> Monitore a saúde do sistema, o volume de transferências e a atividade recente.

> [card] [Transferências](https://docs.lerian.studio/pt/interfaces/ted-jd/console/bt-managing-transfers)
>
> Navegue, filtre e exporte transferências de todos os tipos e status.

> [card] [Conciliação](https://docs.lerian.studio/pt/interfaces/ted-jd/console/bt-managing-reconciliation.md)
>
> Revise as transferências marcadas para conciliação e seus códigos de falha.

> [card] [Operações TED IN](https://docs.lerian.studio/pt/interfaces/ted-jd/console/bt-ted-in-operations.md)
>
> Rode o poller de entrada, inspecione lacunas e registre para onde foi o dinheiro retido.

> [card] [Webhooks](https://docs.lerian.studio/pt/interfaces/ted-jd/console/bt-webhooks.md)
>
> Registre endpoints de webhook, rotacione o segredo de assinatura deles e tente de novo as entregas com falha.

> [card] [Configurações](https://docs.lerian.studio/pt/interfaces/ted-jd/console/bt-managing-settings)
>
> Configure horário de funcionamento, limites de uso e política de tarifas.

> [card] [Rotas Contábeis](https://docs.lerian.studio/pt/interfaces/ted-jd/console/bt-accounting-routes.md)
>
> Vincule cada escopo às rotas contábeis do Midaz com que o plugin lança.

## Status das transferências

***

As transferências passam por um conjunto de status do ciclo de vida. O Dashboard, a lista Transferências e a página de detalhes da transferência mostram os mesmos status.

| Status | Significado |
| - | - |
| Criado | A transferência foi criada e está na fila para processamento. |
| Recebida | TED de entrada recebida da JD, antes do crédito. |
| Pendente | TED Out com o valor retido. A JD ainda não a recebeu, então você ainda pode cancelá-la. |
| Processando | Em trânsito na contraparte. |
| Concluído | A transferência terminou com sucesso. |
| Falha | O processamento falhou. |
| Rejeitado | A contraparte rejeitou a transferência. |
| Cancelado | Cancelada por um usuário antes da conclusão. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.