Calculating a Loan Payment Schedule

Generates a loan payment schedule based on the repayment type (annuity or differentiated). Returns the full schedule broken down into principal and interest.

URL

Method: POST

Production: https://registry.wallet.kvell.group/reg2/billing/loans/pay/schedule

Request parameters

Name	Data type	Required	Description
`issueDate`	date	Yes	Loan issue date in YYYY-MM-DD format
`loanAmount`	number	Yes	Loan amount
`annualRate`	number	Yes	Loan rate (%)
`termMonths`	integer	Yes	Loan term in months
`type`	string	Yes	Payment type: ANNUITY or DIFFERENTIATED

Request example

{
  "issueDate": "2025-01-01",
  "loanAmount": 100000,
  "annualRate": 20,
  "termMonths": 12,
  "type": "ANNUITY"
}

Request headers

Name	Data type	Required	Description
`X-Api-Key`	string	Yes	Unique identifier (UUID)

Response

Response example

200: OK

{
  "payments": [
    { "date": "2025-02-01", "payment": 9263, "principal": 7596, "interest": 1667, "balance": 92404 }
  ],
  "totalPayment": 305587,
  "totalInterest": 5587
}

Response parameters

Name	Data type	Description
`payments`	array	Payment schedule
`payments[].date`	date	Payment date
`payments[].payment`	number	Payment amount
`payments[].principal`	number	Principal amount
`payments[].interest`	number	Interest amount
`payments[].balance`	number	Remaining balance
`totalPayment`	number	Total of all payments
`totalInterest`	number	Total interest