/api/v1/br/...). Everything here applies to loans originated under the Brazil jurisdiction. Portuguese domain terms stay 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. The Brazilian profile pins the IOF rates, so a preview and the disbursement that follows it compute the same amounts. Preview the daily and the additional IOF component, and the net amount the borrower receives, before you originate:
POST /api/v1/br/tax/preview
At disbursement, send jurisdictionExtensions with disbursedAt, loanProductVersionId, and requestId, the call’s X-Idempotency value. Lender computes the IOF from them and accepts the disbursement only when the net equals gross minus that IOF, minus a retained origination fee.
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. The server canonicalizes the text, recomputes the hash, and rejects any mismatch. The recorded consent is therefore 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. Lender records each stage change as a transition, not as a silent overwrite.
The number of days overdue drives staging. The later stages also suspend interest accrual, so the accrual run skips those accounts.
The nightly promotion sweep
Stages also advance on their own. A daily sweep reads the overdue book for the business day, measures each account against the Res. CMN 4.966 provisioning ladder in force, and applies the same transition operation above wherever the stage should change. A loan that ages past a boundary is therefore restaged without anyone calling the API. The sweep ships on, and it runs at 05:00 UTC until you give it another schedule. Every deployment runs it against its own book. The sweep reads the portfolio snapshot for the business day, so it builds that snapshot itself when nothing else did, and fails that tenant’s sweep when it cannot. A book nobody measured and a book with nothing overdue look identical from the outside, and the sweep refuses to report the first as the second. SetJOBS_PDD_PROMOTION_ENABLED=false to turn it off. Stages then change only when you call the transition operation.
On a default deployment this sweep is also the only producer of the portfolio snapshot, because the dedicated snapshot job ships off. Turn the sweep off and you have to enable JOBS_PORTFOLIO_SNAPSHOT_ENABLED in its place, or the portfolio dashboard and the delinquent-loan register refuse every business date with 503.
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
A Brazilian loan account settles early against a prepayment quote: create the quote first, then prepay with its identifier. The quote is valid for 24 hours and accepts one settlement, and the amount you settle must equal the quote’s net settlement amount. The BR prepayment route mirrors the generic one and takes the same
X-Idempotency key.
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. The contract and its audit trail then stay explicit about each refusal.
Business calendar
Brazilian date math (accruals, schedule dates, settlement) uses a Brazilian business calendar. That calendar has ANBIMA holidays and an Actual/252 day-count convention. Installment and accrual dates therefore land on business days.
BR products
You create and version Brazilian products 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,POST /api/v1/br/loan-products/{id}/promote
Next steps
Consignado privado
The Brazilian journey: payroll-deducted lending end to end.