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

# TED: documentação alinhada com a v2.4.0

> A documentação pública do TED agora reflete a versão 2.4.0, incluindo campos de transferência, webhooks, configuração e referências de erro.

6 de maio de 2026Atualização da documentaçãoRevisão obrigatória

## Afeta

***

Equipes que usam a documentação pública do TED para construir ou revisar integrações com `plugin-br-bank-transfer`.

Esta atualização se aplica ao portal público de documentação. Ela não muda o comportamento da API em runtime.

> [!NOTE]
>
> O portal público de documentação é a referência voltada ao cliente. Recomenda-se que os arquivos-fonte do repositório não sejam tratados como artefatos de integração nem como especificações de API baixadas para uso do cliente.

## O que mudou

***

### Referência da API

A referência da API do TED agora identifica a versão documentada como `2.4.0` e foi atualizada onde a documentação pública tinha divergido do comportamento do plugin.

A principal correção é o modelo de requisição de transferência: `InitiateTransferRequest` agora documenta o campo obrigatório `purpose`, que mapeia para o `FinlddCli` do SPB do BACEN e aceita um código numérico de 1 a 4 dígitos.

Outras atualizações na referência incluem:

* Metadados de versão corrigidos para `2.4.0`.
* `amount` restaurado na lista de campos obrigatórios.
* `TransferList` e `TransferSummary` alinhados com os DTOs de resposta em Go.
* `ReadinessResponse.checks` esclarecido para incluir a verificação `auth`.
* Códigos de erro fantasmas removidos do catálogo público de erros.
* Códigos do fornecedor JD esclarecidos, incluindo `AAC90` e `ALN01`.

### Guias e detalhes operacionais

Os guias do TED também foram limpos para que o portal de documentação corresponda ao comportamento atual do plugin:

* Variáveis de configuração corrigidas.
* `X-Organization-Id` documentado no guia do desenvolvedor.
* Exemplos de envelope de webhook corrigidos.
* Semântica do jitter de nova tentativa atualizada para corresponder à implementação.
* As páginas de TED IN, TED OUT, boas práticas, modelo de dados, glossário e visão geral receberam correções menores.

## Impacto

***

Esta é uma atualização de documentação. Ela torna a documentação pública mais precisa, em especial para equipes que implementam a criação de transferências.

Se você cria requisições de transferência TED, seu payload deve incluir `purpose`.

## O que você precisa fazer

***

**Step 1**

Revise seus payloads de criação de transferência TED.

**Step 2**

Confirme que `purpose` é enviado com `InitiateTransferRequest`.

**Step 3**

Use a documentação pública atualizada para nomes de campos, campos obrigatórios, exemplos de webhook e referência de erros.

**Step 4**

Não trate os arquivos-fonte do repositório como artefatos de integração do cliente. Use o portal de documentação como a referência voltada ao cliente.

### Prazo

Antes de criar ou atualizar uma integração de transferência TED.

### Por quê

A documentação anterior misturava o comportamento correto do produto com detalhes de referência obsoletos e metadados de versão incorretos. Esta atualização remove essa ambiguidade e mantém a documentação pública focada no que os clientes precisam para implementar corretamente.

## Recursos

***

* [Configuração do TED](https://docs.lerian.studio/pt/interfaces/ted-jd/ted-configuration.md)
* [Guia do desenvolvedor do TED](https://docs.lerian.studio/pt/interfaces/ted-jd/ted-developer-guide.md)
* [Webhooks do TED](https://docs.lerian.studio/pt/interfaces/ted-jd/ted-webhooks.md)
* [Lista de erros do TED](https://docs.lerian.studio/pt/reference/interfaces/ted-jd/ted-error-list.md)


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