Saltar al contenido principal
POST
Disburse loan application

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Canonical idempotency request ID.

Parámetros de ruta

id
string<uuid>
requerido

Loan application identifier.

Ejemplo:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Cuerpo

application/json
grossRequestedAmount
string
requerido

Gross requested disbursement amount as a decimal string (e.g. "50000.00").

Ejemplo:

"50000.00"

loanAccountId
string
requerido

Loan account identifier (UUID).

Ejemplo:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

netDeliveredAmount
string
requerido

Net delivered disbursement amount as a decimal string (e.g. "49500.00"). Must equal grossRequestedAmount minus the jurisdiction withholdings minus the origination fee the product version's origination_fee template sets for this release; POST /api/v1/br/tax/preview quotes both.

Ejemplo:

"49500.00"

currency
string

Optional ISO-4217 currency assertion (3 uppercase letters). When present it MUST equal the loan application's currency (a double-entry guard); a divergence is rejected with 422. When omitted, the loan's own currency is used.

Required string length: 3
Pattern: ^[A-Z]{3}$
Ejemplo:

"BRL"

disbursedAt
string

Disbursement timestamp (RFC3339). Omit it and Lender stamps the tenant's business now. A day after the São Paulo day three calendar months from today is refused (LENDER-0212).

Ejemplo:

"2026-06-14T12:00:00Z"

firstDueDate
string

Day the first instalment falls due (YYYY-MM-DD or RFC3339), read exactly as the schedule preview and the tax quote read it: an RFC3339 instant names the Brazilian civil day it falls on, so 2026-03-09T22:00:00-03:00 is 9 March. OPTIONAL, and normally omitted: the application records its first instalment date and the release keeps it. A date other than the recorded one is refused (LENDER-0950). A later tranche may repeat the date its first tranche recorded; any other date is refused (LENDER-0235), as is any date on a contract released before the date existed.

Ejemplo:

"2026-03-10"

jurisdictionExtensions
object

Opaque per-jurisdiction disbursement payload, stored and replay-checked whole; in Brazil the Lender reads only the capitalization clause consent from it (capitalizationClauseConsentSupplied, capitalizationClauseConsent), and no other key changes the tax or the CET.

trancheNumber
integer<int64>

Optional tranche position for a multi-tranche release: 1 for the first, 2 for the second, and so on. It must be exactly one more than the number of disbursements this application already carries. Omit it only for an application's SINGLE disbursement, which must then release the approved amount exactly — a second disbursement that declares no tranche is refused 409 LENDER-0201, and a wrong position or a total above the approved amount is refused 422 LENDER-0202.

Rango requerido: x >= 1
Ejemplo:

2

Respuesta

OK

amortizationSystem
enum<string>
requerido

Amortization system the contract is struck under; price when the proposal asked for none.

Opciones disponibles:
price,
sac,
american
Ejemplo:

"price"

assignedOfficerId
string
requerido

Authenticated officer who created the application (request subject), or empty on a system-originated application, which has no human officer. Whatever the identity provider issues as the subject: not necessarily a UUID, at most 255 characters.

Ejemplo:

"officer-xyz"

borrowerId
string<uuid>
requerido

The borrower's holder id in the Midaz CRM of the product's institution (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440002"

expectedDisbursementDate
string
requerido

Expected disbursement date (RFC3339, UTC).

Ejemplo:

"2026-06-14T12:00:00Z"

id
string
requerido

Loan application identifier (UUID).

Ejemplo:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

loanProductVersionId
string
requerido

Loan product version this application was created against (UUID).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

paymentPeriodicity
enum<string>
requerido

How often an instalment falls due; monthly when the proposal asked for none.

Opciones disponibles:
monthly,
fortnightly,
weekly
Ejemplo:

"monthly"

previewJurisdictionCode
string
requerido

ISO-2 jurisdiction code resolved at preview time.

Ejemplo:

"BR"

previewProfileVersion
string
requerido

Jurisdiction profile version resolved at preview time.

Ejemplo:

"1.0.0"

requestedInstallments
integer<int64>
requerido

Number of installments requested, on the periodicity of the contract.

Ejemplo:

24

requestedInterestRate
string
requerido

Requested monthly interest rate as a decimal string, scale 8 (e.g. "0.00000100").

Ejemplo:

"0.00000100"

requestedPrincipalAmount
string
requerido

Requested principal amount as a decimal string, minor-unit precision scale 2 (e.g. "50000.00"). On a proposal asked by its instalment, the principal the Lender resolved for it; on one asked by its net, the gross the Lender resolved for it.

Ejemplo:

"50000.00"

status
string
requerido

Lifecycle status: one of pending_approval, approved, rejected, withdrawn, disbursed.

Ejemplo:

"pending_approval"

approvalDecision
object

Approval facts; present only when the application is approved or disbursed.

borrowerKind
string

Whose credit this is: pessoaFisica for a CPF borrowerDocument, pessoaJuridica for a CNPJ. ABSENT on an application created before the declaration existed: such an application cannot be taxed or described, and the paths that need the kind refuse it with LENDER-0230 rather than assuming one.

Ejemplo:

"pessoaFisica"

clientContractNumber
string

The client's own number for this contract, exactly as recorded at creation. ABSENT when the contract has none.

Ejemplo:

"CTR-2026-000123"

disbursementEvent
object

Disbursement facts; present only when the application is disbursed.

firstDueDate
string

First instalment date the application records (YYYY-MM-DD). ABSENT on an application created before the date was recorded, on a payroll-rail application and on a renegotiated contract.

Ejemplo:

"2026-07-14"

paymentRules
object[] | null

Rows the proposal pays by rule instead of the system's share, as sent. ABSENT when the ladder is the system's alone.

previewScheduleSnapshotId
string

Schedule offer this application cites (UUID). ABSENT when it cites none, which is allowed: simulating first is optional.

Ejemplo:

"6ba7b810-9dad-11d1-80b4-00c04fd430c8"

rejectionDecision
object

Rejection facts; present only when the application is rejected.

requestedInstallmentAmount
string

Instalment the proposal was asked by, as a decimal string, minor-unit precision scale 2. ABSENT when the proposal named another amount.

Ejemplo:

"300.00"

requestedNetAmount
string

Net the proposal was asked by, as a decimal string, minor-unit precision scale 2. ABSENT when the proposal named another amount.

Ejemplo:

"10000.00"

taxRegime
string

Tax regime the borrower declared at creation. ABSENT when none was declared, and the release uses the loan product version's regime.

Ejemplo:

"brazilSimplesNacional"

withdrawalDecision
object

Withdrawal facts; present only when the application is withdrawn.