Create loan adjustment

Creates a manual adjustment on one component of one loan installment.

The direction of the adjustment comes from the processing code's balance_impact:

  • 1 (credit): reduces the selected component. The customer owes less and the account is credited.
  • -1 (debit): increases the selected component. The customer owes more and the account is debited.

The endpoint rejects processing codes with any other balance_impact (including 0). The loan_balance_impact field
selects the component (PRINCIPAL, INTEREST, TAX, PENALTY or FEE) but does not set the direction.

A reduction cannot exceed the component's outstanding amount on the installment, including payments, accruals and
earlier adjustments already booked. Adjustments are not allowed on CANCELED, PAID or PAID_WITHIN_GRACE installments.

The adjustment_amount cannot have more decimal places than the installment's currency allows, in either direction.

Only one adjustment per loan can be in progress. Until the previous adjustment on the loan is booked (usually a few
seconds), a new request on the same loan is rejected with WLND0001 and can be retried.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID of the loan the operation applies to

Body Params

Request body.

double
required

Amount of the adjustment. It cannot have more decimal places than the installment's currency allows (for example, 2 for USD and BRL, 0 for JPY).

string
enum
required

Installment component to adjust. It does not set the direction; the processing code's balance_impact does.

Allowed:
string
required

Processing code of the adjustment. Its balance_impact sets the direction: credit (1) reduces the installment component selected in loan_balance_impact (for example, principal or interest), and debit (-1) increases it.

uuid
required

Repayment ID

Headers
uuid
required

Required UUID that makes the request idempotent, enabling you to retry it multiple times while the system processes it only once.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json