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

# Consignado privado

> Crédito com desconto em folha no Brasil: o vocabulário, de onde vêm os termos comerciais, o modelo de garantias e os tópicos de ciclo de vida da averbação.

**Consignado privado** é o crédito com desconto em folha do setor privado. O empregador pagador retém cada parcela na fonte, do salário do tomador. Ele funciona como um bounded context brasileiro completo sobre o [Pacote regulatório Brasil](/pt/products/lender/brazil-regulatory-pack). Ele tem vocabulário próprio, modelo de garantias próprio e tópicos de ciclo de vida próprios.

## O vocabulário

***

| Termo           | Explicação                                                                                                  |
| --------------- | ----------------------------------------------------------------------------------------------------------- |
| **Consignado**  | Crédito com desconto em folha — os pagamentos são retidos do salário na fonte.                              |
| **Averbação**   | Registro do desconto em folha junto à entidade pagadora, para que as parcelas sejam retidas a cada período. |
| **Margem**      | A margem consignável — a parte do salário disponível para desconto.                                         |
| **Vínculo**     | O vínculo empregatício entre tomador e empregador contra o qual o empréstimo é descontado.                  |
| **Competência** | O período de folha (uma referência `YYYYMM`) em que uma parcela é descontada.                               |
| **CCB**         | *Cédula de Crédito Bancário* — o instrumento de crédito bancário do empréstimo.                             |

## De onde vêm os termos comerciais

***

Seu motor de crédito precifica um empréstimo consignado. A taxa, a taxa anual, o CET, o IOF e o plano de parcelas são fatos contratados que o Lender registra, nunca valores que o Lender calcula. O Lender vincula esses termos a uma versão de produto de empréstimo.

Os campos de valor e de taxa trafegam como strings decimais (nunca floats), de forma consistente com o modelo de dinheiro do ledger.

## Garantias opcionais

***

Um contrato de consignado pode carregar garantia de FGTS e de verbas rescisórias junto com o desconto em folha. Um contrato ou declara garantia e carrega pelo menos um dos três valores, ou não declara nenhuma e não carrega nenhum.

| Campo                              | Significado                                                          |
| ---------------------------------- | -------------------------------------------------------------------- |
| `valorSaldoDisponivelGarantiaFgts` | Valor do saldo de FGTS dado em garantia (de *consultar-saldo-fgts*). |
| `valorMultaRescisoriaGarantiaFgts` | Valor da multa rescisória do FGTS dado em garantia.                  |
| `percVerbaRescisoriaGarantia`      | Fração das verbas rescisórias dada em garantia, limitada a `0.35`.   |

Os dois campos de FGTS são valores monetários (strings decimais, escala 2). A fração de verbas usa uma string decimal (escala 8). O Lender valida cada campo.

A garantia fica fora do balanço: os saldos de FGTS ficam sob custódia da CAIXA e nunca são lançados no ledger. O Lender acompanha a garantia dada como um registro de domínio no contrato, não como um lançamento no Midaz.

## O ciclo de vida do trilho

***

O trilho Dataprev combina comandos HTTP autenticados com fatos de negócio assíncronos. Em `develop`, a API HTTP do Consignado admite averbação. O gateway não consome um comando de averbação vindo do stream do Lender.

* Os comandos do Lender usam `lerian.streaming.lender.commands`.
* Os fatos do Consignado usam `lerian.streaming.consignado-gw`.
* A identidade do evento vem de headers CloudEvent qualificados por source, não de um tópico por evento.

| Chave do evento                                                                             | Direção | Comportamento em runtime                                                                                                                                                                                                                                    |
| ------------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `consignado.redirecionamento.requested`                                                     | saída   | O gateway executa o comando quando um adaptador está conectado, e retorna uma recusa nomeada nos demais casos.                                                                                                                                              |
| `consignado.exclusao.requested`                                                             | saída   | O gateway resolve o mesmo serviço idempotente de exclusão que o HTTP; quando o runtime está indisponível, ele retorna um erro nomeado.                                                                                                                      |
| `consignado.contract.registered` / `consignado.disbursement.confirmed`                      | entrada | Fatos de contabilização e de comprovação de pagamento.                                                                                                                                                                                                      |
| `consignado.averbacao.rejected` / `consignado.employment_status.reported`                   | entrada | Fatos de rejeição e de situação de emprego.                                                                                                                                                                                                                 |
| `consignado.redirecionamento.confirmed` / `consignado.redirecionamento.rejected`            | entrada | Resultados de redirecionamento.                                                                                                                                                                                                                             |
| `consignado.exclusao.confirmed` / `consignado.exclusao.rejected`                            | entrada | Resultados de exclusão.                                                                                                                                                                                                                                     |
| `consignado.reconciliation.received`                                                        | entrada | Conciliação de escrituração de folha, repasse da CEF, CSV do portal ou recuperação de garantia.                                                                                                                                                             |
| `consignado.contract_correction.available` / `consignado.disbursement_correction.available` | entrada | O gateway publica ponteiros autenticados para recursos de CCB ou de pagamento corrigidos; o Lender busca e verifica os digests SHA-256 deles.                                                                                                               |
| `consignado.portabilidade.efetivada` / `consignado.portabilidade.rejeitada`                 | entrada | Quando o consumidor de resultados está habilitado e o manifesto do gateway em produção declara o evento, os resultados de exclusão por portabilidade no lado de origem encerram a gestão da carteira depois da efetivação, ou preservam a recusa publicada. |

Use a [referência da API do Consignado](/pt/reference/rails/consignado/fetch-consignado-worker-margin) para comandos e consultas do trilho. Os contratos de produtor e consumidor ficam em [Eventos do Lender](/pt/products/lender/lender-events) e [Eventos do Consignado](/pt/reference/events/consignado).

## Gate de contratação

***

O padrão de `CONSIGNADO_ENABLED` é `true`. A rota de contratação, o assinador de CCB dela e o consumidor de entrada de averbação confirmada foram aposentados. Essa configuração agora controla apenas o tratamento legado de entrada de averbação rejeitada. A gestão da carteira de contratos existentes continua disponível. Quando você a desabilita, mantenha também `CONSUMER_CONSIGNADO_AVERBACAO_REJECTED_ENABLED` desligado. A inicialização rejeita essa configuração contraditória. Os fluxos substitutos de contabilização e pagamento se configuram de forma independente.

## Opcional: conciliação com o Matcher

***

Essa integração é controlada por configuração e exige que o Matcher use `STREAMING_CLOUDEVENTS_SOURCE=matcher`. O Lender então consome `match_run.completed` de `lerian.streaming.matcher` e roteia `ce-source: matcher`, `ce-type: studio.lerian.matcher.match_run.completed`, `ce-resourcetype: match_run` e `ce-eventtype: completed`. Se o Matcher usar outro source, inspecione o manifesto de streaming dele e alinhe os dois lados antes de habilitar a integração. O handler traduz o veredito em uma transição de estágio de PDD e na intenção de lançamento correspondente no ledger.

## Próximos passos

***

<Card title="Pacote regulatório Brasil" icon="brazilian-real-sign" href="/pt/products/lender/brazil-regulatory-pack" horizontal>
  CET, IOF, consentimento de capitalização, estágios de PDD e o restante do perfil BR.
</Card>

<Card title="Eventos do Lender" icon="tower-broadcast" href="/pt/products/lender/lender-events" horizontal>
  O contrato de transmissão, os tópicos que o Lender publica e como um handler se mantém seguro.
</Card>
