> ## 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: documentation aligned with v2.4.0

> The public TED documentation now reflects version 2.4.0, including transfer fields, webhooks, configuration, and error references.

<Badge stroke icon="calendar-days" iconType="regular">May 6, 2026</Badge> <Badge stroke icon="file-code" iconType="regular">Documentation update</Badge> <Badge color="red" size="lg" stroke icon="triangle-exclamation" iconType="regular">Review required</Badge>

## Affects

***

Teams using the public TED documentation to build or review integrations with `plugin-br-bank-transfer`.

This update applies to the public documentation portal. It does not change the runtime API behavior.

<Note>
  The public documentation portal is the customer-facing reference. Repository source files should not be treated as integration artifacts or downloaded API specifications for client use.
</Note>

## What changed

***

### API reference

The TED API reference now identifies the documented version as `2.4.0` and was updated where the public documentation had drifted from the plugin behavior.

The main correction is the transfer request model: `InitiateTransferRequest` now documents the required `purpose` field, which maps to BACEN SPB `FinlddCli` and accepts a 1-to-4 digit numeric code.

Other reference updates include:

* Version metadata corrected to `2.4.0`.
* `amount` restored to the required field list.
* `TransferList` and `TransferSummary` aligned with the Go response DTOs.
* `ReadinessResponse.checks` clarified to include the `auth` check.
* Phantom error codes removed from the public error catalog.
* JD vendor codes clarified, including `AAC90` and `ALN01`.

### Guides and operational details

The TED guides were also cleaned up so the documentation portal matches the current plugin behavior:

* Configuration variables corrected.
* `X-Organization-Id` documented in the developer guide.
* Webhook envelope examples corrected.
* Retry jitter semantics updated to match the implementation.
* TED IN, TED OUT, best practices, data model, glossary, and overview pages received smaller corrections.

## Impact

***

This is a documentation update. It makes the public documentation more accurate, especially for teams implementing transfer creation.

The important integration signal is `purpose`: if you create TED transfer requests, your payload must include this field.

## What you need to do

***

<Steps>
  <Step>
    Review your TED transfer creation payloads.
  </Step>

  <Step>
    Make sure `purpose` is sent with `InitiateTransferRequest`.
  </Step>

  <Step>
    Use the updated public documentation for field names, required fields, webhook examples, and error reference.
  </Step>

  <Step>
    Do not treat repository source files as client integration artifacts. Use the documentation portal as the customer-facing reference.
  </Step>
</Steps>

### Deadline

Before creating or updating a TED transfer integration.

### Why

The previous documentation mixed correct product behavior with stale reference details and incorrect version metadata. This update removes that ambiguity and keeps the public documentation focused on what customers need to implement correctly.

## Resources

***

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