/api/v1/br/...) and applies to loans originated under the Brazil jurisdiction. Portuguese domain terms are kept as-is, with a gloss — see Core concepts for the full list.
CET — Custo Efetivo Total
CET (Custo Efetivo Total, total effective cost of credit) is the all-in cost disclosed to the borrower — interest plus taxes and fees. Lender persists the CET disclosure at origination and exposes it per loan account:
GET /api/v1/br/loan-accounts/{id}/cet-disclosure
IOF and tax preview
IOF (Imposto sobre Operações Financeiras) is the federal tax on credit operations. Preview the tax amounts a prospective operation would incur before you originate it:
POST /api/v1/br/tax/preview
Capitalization consent
Brazilian compound-interest (juros compostos) capitalization requires the borrower’s explicit consent. Lender records that consent as an integrity-checked ceremony: the client submits the clause text and its hash, and the server canonicalizes the text, recomputes the hash, and rejects any mismatch — so the recorded consent is provably the clause the borrower saw.
POST /api/v1/br/loan-applications/{id}/capitalization-consents
PDD staging
PDD (Provisão para Devedores Duvidosos) is loan-loss provisioning. Each loan account sits in a PDD stage, and stage changes are tracked transitions rather than silent overwrites. A daily promotion job advances stages as loans age.
| Operation | Purpose |
|---|---|
GET /api/v1/br/loan-accounts/{id}/pdd-stage | Read the current PDD stage. |
POST /api/v1/br/loan-accounts/{id}/pdd-stage/transitions | Apply a PDD stage transition. |
Credit operation descriptor
The credit descriptor is the SCR-style credit-operation profile for a loan account — the regulated description of the operation.
GET /api/v1/br/loan-accounts/{id}/credit-descriptor
Prepayment quote
Before recording a Brazilian prepayment, take a binding quote for the early settlement, then settle against it. The BR prepayment route mirrors the generic one and preserves the idempotency-aware handling.
| Operation | Purpose |
|---|---|
POST /api/v1/br/loan-accounts/{id}/prepayment-quote | Create a prepayment quote (partial or full). |
POST /api/v1/br/loan-accounts/{id}/prepayments | Prepay the loan account (BR alias). |
CDC caps
Brazilian consumer-credit (CDC) products can carry regulatory caps — for example a late-fee ceiling. Lender enforces caps by rejecting a charge that would violate them, rather than silently clamping the amount, so the contract and its audit trail stay explicit about what was refused.
Business calendar
Brazilian date math (accruals, schedule dates, settlement) uses a Brazilian business calendar with ANBIMA holidays and an Actual/252 day-count convention, so installment and accrual dates land on business days.
BR products
Brazilian products are created and versioned through jurisdiction-aware aliases that accept the BR extensions:
POST /api/v1/br/loan-products,GET /api/v1/br/loan-products,GET /api/v1/br/loan-products/{id}POST /api/v1/br/loan-products/{id}/versions,POST /api/v1/br/loan-products/{id}/activate
Next steps
Consignado privado
The flagship Brazilian journey — payroll-deducted lending end to end.