Skip to main content
Consignado privado is payroll-deducted private-sector lending: installments are withheld at source from the borrower’s salary by the paying employer. It is the deepest journey Lender ships today — a full Brazilian bounded context on top of the Brazil regulatory pack, with its own origination flow, credit instrument, and lifecycle events.

​
The vocabulary

TermGloss
ConsignadoPayroll-deducted credit — repayments are withheld from salary at source.
AverbaçãoRegistration of the payroll deduction with the paying entity, so installments are withheld each period.
MargemThe consignable margin — the portion of salary available for deduction.
VínculoThe employment link between borrower and employer that the loan is deducted against.
CompetênciaThe payroll period (a YYYYMM reference) an installment is deducted in.
CCBCédula de Crédito Bancário — the bank credit instrument issued and signed for the contract.

​
Contratação ativa — origination in one call

Active origination happens through a single endpoint: POST /api/v1/br/consignado/contracts That one call orchestrates the whole origination:
1

Re-check the margin

Lender re-checks the borrower’s consignable margem against the employment vínculo before committing, so a contract is never originated beyond the available margin.
2

Render and sign the CCB

The CCB is rendered as a PDF and signed with an digital signature, producing the legally binding credit instrument.
3

Create and approve the core application

Lender creates and approves the core loan application — carrying its BR consignado extension — and persists it, reusing the same origination machinery as every other loan.
4

Request averbação

Lender emits consignado.averbacao.requested so an external payroll-deduction gateway performs the real averbação with the paying entity.
The response reflects the core origination progress — approved on contratação. The averbação lifecycle is tracked separately through events, because it depends on the paying entity acting.

​
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. On top of the core event catalog, the consignado context contributes its own signals:
EventDirectionMeaning
consignado.margin.requested / consignado.margin.fetchedout / inAsk the rail for the consignable margin, and receive it.
consignado.proposal.acceptedinThe borrower accepted the proposal.
consignado.averbacao.requestedoutAsk the rail to register the payroll deduction.
consignado.averbacao.confirmed / consignado.averbacao.rejectedinThe rail confirmed or refused the averbação.
consignado.exclusao.requestedoutAsk the rail to remove a registered deduction.
consignado.reconciliation.receivedinA reconciliation verdict arrived for the contract.
Money and rate fields cross the wire as decimal strings (never floats), consistent with the ledger’s money model.

​
Optional: reconciliation with Matcher

This integration is off by default and gated by configuration. Document and enable it only when your deployment has explicitly turned it on.
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: nothing is required for the core consignado journey to work.

​
Next steps

Brazil regulatory pack

CET, IOF, capitalization consent, PDD staging, and the rest of the BR profile.

Lender in the platform

How the events and postings behind this journey are delivered.