Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
LoanApplications

Preview amortisation schedule

Computes a deterministic declining-balance schedule for the supplied loan parameters without persisting any data.

post/api/v1/loan-applications/preview-schedule

Request body

annualInterestRatestring required

Annual interest rate as a decimal string (e.g. "0.12000000").

dayCountConventionstring required

Day count convention identifier.

gracePeriodDaysinteger

Grace period in days.

jurisdictionCodestring required

ISO-2 jurisdiction code.

principalAmountstring required

Principal amount as a decimal string (e.g. "50000.00").

startDatestring required

Schedule start date (RFC3339 or YYYY-MM-DD).

termMonthsinteger required

Number of months.

Example request

{
  "annualInterestRate": "0.12000000",
  "dayCountConvention": "ACT/365",
  "gracePeriodDays": 30,
  "jurisdictionCode": "BR",
  "principalAmount": "50000.00",
  "startDate": "2026-06-14T00:00:00Z",
  "termMonths": 24
}

Response

OK

calendarReferencestring required

Identifier of the business calendar used to resolve due dates.

dayCountConventionstring required

Day count convention applied to interest accrual.

jurisdictionCodestring required

ISO-2 jurisdiction code resolved for this preview.

profileVersionstring required

Jurisdiction profile version used to compute the schedule.

totalIntereststring required

Sum of interest across all installments as a decimal string, minor-unit precision scale 2 (e.g. "4321.00").

totalPrincipalstring required

Sum of principal across all installments as a decimal string, minor-unit precision scale 2 (e.g. "50000.00").

Example response

{
  "dayCountConvention": "ACT/365",
  "effectiveCostPreview": {
    "effectiveCostAnnualPct": "12.00000000",
    "effectiveCostMonthlyPct": "0.94888100"
  },
  "installments": [
    {
      "dueDate": "2026-06-14",
      "interestAmount": "234.56",
      "number": 1,
      "principalAmount": "1000.00",
      "remainingBalance": "49000.00",
      "totalAmount": "1234.56"
    }
  ],
  "jurisdictionCode": "BR",
  "profileVersion": "1.0.0",
  "totalInterest": "4321.00",
  "totalPrincipal": "50000.00"
}