Adjust a loan

POST/api/v1/credit/loans/{loan_id}/adjustments

Waive part of a loan's unpaid fee (waive_fee) or accrued interest (waive_interest), or credit its unpaid principal as goodwill (goodwill_credit). The amount may not exceed what is outstanding in that bucket. Posts an adjustment ledger entry with the reason as its memo and, when the program posts to the GL, a journal entry to Fee Waivers, Interest Waivers or Goodwill Credits. A loan brought to zero is paid on effective_on and emits credit.loan.paid. Operator action: API tokens receive 403.

Operation ID: create_loan_adjustment·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

loan_idstringrequired

Request body

Schema: CreditLoanAdjustmentRequest

typestringrequired

waive_fee reduces the unpaid disbursement fee, waive_interest the unpaid accrued interest, goodwill_credit the unpaid principal.

One of: waive_fee, waive_interest, goodwill_credit

amount_centsintegerrequired

At most what is outstanding in that bucket; more is refused.

reasonstringrequired

Why. Recorded on the adjustment and as the ledger memo.

effective_onstring · date

The date the reduction counts from. Defaults to today; not before the loan was originated, and not in the future.

Responses

201Successful Response

Schema: SuccessEnvelope_CreditLoanAdjustmentResult_

successboolean
messagestring
codestring
dataCreditLoanAdjustmentResult

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

404Not Found - Resource does not exist

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Code samples

POST/api/v1/credit/loans/{loan_id}/adjustments

bash

curl -X POST 'https://api.ondayzero.com/api/v1/credit/loans/{loan_id}/adjustments' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "waive_fee",
  "amount_cents": 0,
  "reason": "string"
}'