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

# Como o TED Lerian funciona

> O ciclo de vida de cada transferência do TED Lerian, enviada, recebida e devolvida, com os status que a API retorna e o que cada um significa para o seu cliente.

## Envio de uma TED

***

**1. Validar**

O TED Lerian confere o formato do valor, o código de finalidade de 5 dígitos, o banco do recebedor na lista de participantes do STR. Ele também confere se o documento do recebedor é um CPF ou um CNPJ. Uma falha aqui não cria transferência.

**2. Aplicar a política**

Ele confere a janela efetiva (a grade oficial do STR, o cut-off da instituição e os feriados), os limites de uso e, quando configurada, a tarifa calculada pelo Midaz.

**3. Reservar**

O TED Lerian reserva o valor mais a tarifa na conta de origem. Status `RESERVED`.

**4. Enviar ao STR**

O Lerian SPB aceita o comando e retorna o `nuop`. Status `SUBMITTED`. Este é o status que a resposta de criação costuma mostrar.

**5. Liquidar**

O STR decide de forma assíncrona: liquida, rejeita ou mantém o lançamento pendente. O resultado chega como evento e em uma consulta.

### Status de uma transferência enviada

| Status | O que significa | O que você pode fazer |
| - | - | - |
| `CREATED` | Registrada; nada está reservado ainda. Em uma transferência interna, também significa que a resposta do ledger foi indeterminada, o que o reprocessamento resolve. | Cancelar |
| `RESERVED` | Valor e tarifa reservados; prestes a ir para o STR. | Cancelar |
| `SUBMITTED` | Enviada ao STR, aguardando a decisão dele. | Aguardar |
| `PENDING_STR` | O STR aceitou o lançamento e o mantém pendente. A reserva continua. | Pedir ao STR que cancele (`202`) |
| `SETTLED` | Liquidada; o débito é definitivo. Status final. | Nada. Uma devolução da outra instituição aparece em `returned`. |
| `REJECTED` | Recusada pelo ledger, pelo Lerian SPB, pelo STR ou por um operador, com `rejection.code`, `reason` e `source`. A reserva é liberada. Status final. | Nada |
| `CANCELLED` | Cancelada; a reserva é liberada. Status final. | Nada |
| `AWAITING_RECONCILIATION` | Sem resposta a tempo. A reserva nunca é liberada por timeout; a conciliação pede o resultado ao Lerian SPB. | Um operador destrava com evidência |
| `EXHAUSTED` | A conciliação automática esgotou as tentativas; o resultado continua desconhecido. | Um operador destrava com evidência |

> [!NOTE]
>
> Aceita não é liquidada. Um `201` confirma que a TED foi aceita e, em regra, enviada. O dinheiro só saiu quando o status é `SETTLED`. Uma recusa pelo ledger ou pelo Lerian SPB já pode vir na resposta de criação (`rejection.source` `LEDGER` ou `RAIL`). Uma recusa pelo STR ou por um operador só aparece em uma consulta posterior.

## Transferências internas

***

Quando o banco do recebedor é o próprio ISPB da instituição, o TED Lerian encontra a conta do recebedor no CRM do Midaz. Ele liquida tudo em uma única transação no Midaz. A janela do STR não se aplica, mas os limites de uso e, quando configurada, a tarifa se aplicam. A resposta tem `type=INTERNAL` e `recipient.accountId` preenchido. Se o recebedor não existir ou pertencer a outra organização, o TED Lerian recusa a requisição com `TED-1021` e não cria transferência.

## Recebimento de uma TED

***

**1. Registrar**

O Lerian SPB informa que o STR liquidou uma TED para a instituição. O prazo de 60 minutos começa em `interbankSettledAt`.

**2. Rotear**

O TED Lerian encontra o vínculo de ISPB da instituição recebedora. Sem vínculo, a TED vai para revisão manual.

**3. Encontrar e conferir**

O TED Lerian busca a agência, a conta e o documento do recebedor no CRM do Midaz. O titular e o tipo de conta precisam corresponder.

**4. Decidir**

Ele credita o cliente, devolve a TED com o motivo oficial ou a envia para revisão manual.

| Status | O que significa |
| - | - |
| `RECEIVED` | O STR liquidou a TED e o TED Lerian a registrou. A decisão está em andamento. |
| `CREDITED` | O valor foi creditado ao cliente. |
| `RETURN_REQUESTED` | A devolução foi para o STR com o motivo oficial. |
| `RETURNED` | O STR liquidou a devolução; o dinheiro voltou para a instituição remetente. |
| `MANUAL_REVIEW` | O TED Lerian não conseguiu concluir sozinho, ou o STR recusou a devolução. Um operador decide. |

Quando o Lerian SPB entrega uma TED duas vezes, o TED Lerian a credita apenas uma vez.

## Quando outra instituição devolve a sua TED

***

O TED Lerian encontra a transferência original, registra a devolução no bloco `returned` da transferência e credita o valor de volta ao remetente. A transferência continua `SETTLED`, e `transfer.returned` avisa o seu sistema. Por padrão, o TED Lerian não reembolsa a tarifa de envio. `returned.feeRefunded` diz se reembolsou.

Se nenhuma transferência liquidada carrega ainda o número de controle da TED devolvida, o TED Lerian retém a devolução. Ele aplica a devolução quando essa transferência liquida. Um operador lista as devoluções retidas com `GET /v1/reconciliation/held-returns`.

## Cancelamento

***

| Status atual | Resultado |
| - | - |
| `CREATED`, `RESERVED` | `200`, cancelada na hora, reserva liberada. Enquanto uma chamada ao Midaz ou ao Lerian SPB para a transferência está em andamento, `409 TED-0061`. |
| `PENDING_STR` | `202`, cancelamento pedido ao STR. O resultado chega como `transfer.cancelled` ou `transfer.settled`. Esse cancelamento vem desligado por padrão. Enquanto ele está desligado, a resposta é `503 TED-1012`. |
| `CANCELLED` | `200`, sem novo efeito. |
| `SUBMITTED`, `SETTLED`, `REJECTED` | `409 TED-0061`. Para dinheiro que já saiu, o caminho é uma devolução pela outra instituição. |
| `AWAITING_RECONCILIATION`, `EXHAUSTED` | `409 TED-0061`. O status real no STR é desconhecido; destrave com evidência em vez disso. |

TEDs recebidas nunca podem ser canceladas.

## Conciliação e destravamento

***

Uma transferência sem resposta a tempo entra na fila de conciliação com a sua idade e o último status conhecido. Por padrão, o TED Lerian pede o resultado ao Lerian SPB 15 minutos depois de aceitar a transferência e tenta até 8 vezes. Liquidada transforma a reserva em débito, e rejeitada libera a reserva. Qualquer outra resposta, inclusive não encontrada, mantém a reserva até a próxima tentativa. Quando as tentativas acabam, a transferência vira `EXHAUSTED` e um operador a destrava com a evidência. Nada é revertido sem evidência.

Uma verificação periódica também procura inconsistências entre o Midaz e os status das transferências, como uma devolução sem recrédito ou uma reserva órfã. Ela as lista para o operador.


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