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

> Payroll-deducted lending in Brazil — the vocabulary, where the commercial terms come from, the collateral model, and the averbação lifecycle topics.

export const GReconciliation = ({children}) => <Tooltip headline="Reconciliation" tip="The process of comparing two sets of records — for example, your internal ledger against bank statements — to verify they match and flag discrepancies." cta="See glossary" href="/en/glossary">
    {children}
  </Tooltip>;

**Consignado privado** is payroll-deducted private-sector lending. The paying employer withholds each installment at source, from the borrower's salary. It is a full Brazilian bounded context on top of the [Brazil regulatory pack](/en/lender/brazil-regulatory-pack). It has its own vocabulary, its own collateral model, and its own lifecycle topics.

## The vocabulary

***

| Term            | Gloss                                                                                                   |
| --------------- | ------------------------------------------------------------------------------------------------------- |
| **Consignado**  | Payroll-deducted credit — repayments are withheld from salary at source.                                |
| **Averbação**   | Registration of the payroll deduction with the paying entity, so installments are withheld each period. |
| **Margem**      | The consignable margin — the portion of salary available for deduction.                                 |
| **Vínculo**     | The employment link between borrower and employer that the loan is deducted against.                    |
| **Competência** | The payroll period (a `YYYYMM` reference) an installment is deducted in.                                |
| **CCB**         | *Cédula de Crédito Bancário* — the bank credit instrument for the loan.                                 |

## Where the commercial terms come from

***

Your credit engine prices a consignado loan. The rate, the annual rate, the CET, the IOF and the installment plan are contracted facts Lender records — never values Lender computes. Lender binds those terms to a loan product version.

Money and rate fields cross the wire as decimal strings (never floats), consistent with the ledger's money model.

## Optional collateral (garantias)

***

A consignado contract can carry FGTS and rescission-benefit collateral alongside the payroll deduction. A contract either declares collateral and carries at least one of the three amounts, or declares none and carries none.

| Field                              | Meaning                                                    |
| ---------------------------------- | ---------------------------------------------------------- |
| `valorSaldoDisponivelGarantiaFgts` | FGTS balance amount pledged (from *consultar-saldo-fgts*). |
| `valorMultaRescisoriaGarantiaFgts` | FGTS rescission-penalty amount pledged.                    |
| `percVerbaRescisoriaGarantia`      | Fraction of severance-verbas pledged, capped at `0.35`.    |

The two FGTS fields are money amounts (decimal strings, scale 2). The verbas fraction is a decimal string (scale 8). Lender validates each field.

Collateral is off-balance: FGTS balances stay in CAIXA custody and never post to the ledger. Lender tracks the pledge as a domain record on the contract, not as a Midaz posting.

## The averbação lifecycle

***

Because averbação happens at an external payroll rail, Lender models it as an asynchronous conversation over the streaming backbone rather than a synchronous call. Lender publishes its commands on its own `lender.*` topics, and the payroll-deduction gateway reports facts back on `consignado-gw.*` topics.

**Subscribe by topic, and publish facts on the gateway topic.** The topic is the address on both sides.

| Topic                                                                                                        | Direction | Meaning                                                                                                  |
| ------------------------------------------------------------------------------------------------------------ | --------- | -------------------------------------------------------------------------------------------------------- |
| `lender.consignado_exclusao.requested`                                                                       | out       | Ask the rail to remove a registered deduction.                                                           |
| `lender.consignado_redirecionamento.requested`                                                               | out       | Ask the rail to redirect a contract to a replacement vínculo.                                            |
| `consignado-gw.consignado_averbacao.confirmed` / `consignado-gw.consignado_averbacao.rejected`               | in        | The rail confirmed or refused the averbação.                                                             |
| `consignado-gw.consignado_exclusao.confirmed` / `consignado-gw.consignado_exclusao.rejected`                 | in        | The rail confirmed or refused the removal.                                                               |
| `consignado-gw.consignado_employment_status.reported`                                                        | in        | The rail reported a worker's vínculo was suspended or terminated.                                        |
| `consignado-gw.consignado_redirecionamento.confirmed` / `consignado-gw.consignado_redirecionamento.rejected` | in        | The rail confirmed or refused the redirection.                                                           |
| `consignado-gw.consignado_reconciliation.received`                                                           | in        | A reconciliation verdict arrived — payroll escrituração, CEF repasse, portal CSV, or guarantee recovery. |

The core catalog Lender publishes around these lives in [Lender events](/en/lender/lender-events).

## Contracting gate

***

`CONSIGNADO_ENABLED` defaults to `true`. Set it to `false` only to intentionally remove the contratação route, its CCB signer, and the inbound confirm/reject averbação use cases. Servicing for existing contracts remains available. When you disable it, also keep `CONSUMER_CONSIGNADO_AVERBACAO_CONFIRMED_ENABLED` and `CONSUMER_CONSIGNADO_AVERBACAO_REJECTED_ENABLED` off; startup rejects that contradictory configuration.

## Optional: reconciliation with Matcher

***

<Warning>
  This integration is **off by default** and gated by configuration. Document and enable it only when your deployment has explicitly turned it on.
</Warning>

Consignado contracts can optionally be reconciled against [Matcher](/en/matcher/what-is-matcher). When enabled, a Matcher <GReconciliation>reconciliation</GReconciliation> verdict on a contract is translated into a downstream effect on the loan — a PDD stage transition and a corresponding ledger posting intent. With the integration disabled, the reconciliation consumer is a no-op.

## Next steps

***

<Card title="Brazil regulatory pack" icon="brazilian-real-sign" href="/en/lender/brazil-regulatory-pack" horizontal>
  CET, IOF, capitalization consent, PDD staging, and the rest of the BR profile.
</Card>

<Card title="Lender events" icon="tower-broadcast" href="/en/lender/lender-events" horizontal>
  The wire contract, the topics Lender publishes, and how a handler stays safe.
</Card>