Prepay loan account (BR alias)

BR-aliased path for prepaying a loan account. Resolves to the same handler as the core endpoint, with the jurisdiction resolver inserted into the chain. BR accounts require quoteId; when amount is also provided, it must equal the quote’s net settlement amount. Idempotency is enforced by the lib-commons idempotency middleware via the X-Idempotency header; a reused key with different facts yields 409. A missing quote, malformed UUID, or invalid amount yields 422.

POST /api/v1/br/loan-accounts/{id}/prepayments

Prepay loan account (BR alias)

cURL

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "businessDate": "<string>",
  "effectiveDate": "<string>",
  "transactionId": "<string>",
  "amount": "<string>",
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

201

{
  "previousScheduleVersionId": "<string>",
  "scheduleVersion": {
    "createdAt": "<string>",
    "id": "<string>",
    "installments": [
      {
        "dueDate": "<string>",
        "feesAmount": "<string>",
        "interestAmount": "<string>",
        "number": 123,
        "penaltiesAmount": "<string>",
        "principalAmount": "<string>",
        "principalRemaining": "<string>",
        "totalAmount": "<string>"
      }
    ],
    "loanAccountId": "<string>",
    "reason": "<string>",
    "triggerTransactionId": "<string>",
    "versionNumber": 123,
    "predecessorVersionId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency · string · required

Canonical idempotency request ID. Enforced by the lib-commons idempotency middleware.

Example:

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

Path Parameters

id · string<uuid> · required

Loan account identifier (UUID).

Example:

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

Body

application/json

businessDate · string · required

YYYY-MM-DD business date applied to the prepayment.

Example:

"2026-06-14"

effectiveDate · string · required

YYYY-MM-DD effective date of the prepayment.

Example:

"2026-06-14"

transactionId · string · required

Operator-supplied prepayment transaction identifier.

Maximum string length: 128

amount · string

Prepayment amount (2 d.p. string). Amount-only prepayment is available only for non-BR accounts; BR accounts require quoteId.

Example:

"100.00"

quoteId · string<uuid>

Settlement quote identifier. Required when amount is empty.

Example:

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

Response

201

application/json

Created

previousScheduleVersionId · string · required

Predecessor schedule version UUID.

Example:

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

scheduleVersion · object · required

The newly appended immutable schedule version.

Show child attributes