The vocabulary
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.
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.
The core catalog Lender publishes around these lives in 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
Consignado contracts can optionally be reconciled against Matcher. When enabled, a Matcher 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
Brazil regulatory pack
CET, IOF, capitalization consent, PDD staging, and the rest of the BR profile.
Lender events
The wire contract, the topics Lender publishes, and how a handler stays safe.

