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

<Badge stroke icon="calendar-days" iconType="regular">6 de maio de 2026</Badge> <Badge stroke icon="file-code" iconType="regular">Atualização de documentação</Badge> <Badge color="red" size="lg" stroke icon="triangle-exclamation" iconType="regular">Revisão recomendada</Badge>

## Afeta

***

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

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

<Note>
  O portal público de documentação é a referência voltada ao cliente. Arquivos de origem do repositório não devem ser tratados como artefatos de integração ou especificações de API baixadas para uso em cliente.
</Note>

## O que mudou

***

### Referência de 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 havia divergido do comportamento do plugin.

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

Outras atualizações de referência incluem:

* Metadados de versão corrigidos para `2.4.0`.
* `amount` restaurado para a lista de campos obrigatórios.
* `TransferList` e `TransferSummary` alinhados com as 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 de vendor 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 de retry jitter atualizada para corresponder à implementação.
* Páginas de TED IN, TED OUT, best practices, data model, glossário e overview receberam pequenas correções.

## Impacto

***

Esta é uma atualização de documentação. Ela torna a documentação pública mais precisa, especialmente para times implementando criação de transferência.

O sinal importante de integração é `purpose`: se você cria requisições de transferência TED, seu payload deve incluir esse campo.

## O que você precisa fazer

***

<Steps>
  <Step>
    Revise seus payloads de criação de transferência TED.
  </Step>

  <Step>
    Garanta que `purpose` é enviado com `InitiateTransferRequest`.
  </Step>

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

  <Step>
    Não trate arquivos de origem do repositório como artefatos de integração de cliente. Use o portal de documentação como a referência voltada ao cliente.
  </Step>
</Steps>

### Prazo

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

### Por quê

A documentação anterior misturava 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 clientes precisam para implementar corretamente.

## Recursos

***

* [TED configuration](/pt/midaz/plugins/ted/ted-configuration)
* [TED developer guide](/pt/midaz/plugins/ted/ted-developer-guide)
* [TED webhooks](/pt/midaz/plugins/ted/ted-webhooks)
* [TED error list](/pt/reference/midaz/plugins/ted/ted-error-list)