Skip to main content
POST
/
api
/
v1
/
loan-applications
/
preview-schedule
Preview amortisation schedule
curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-applications/preview-schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "annualInterestRate": "<string>",
  "dayCountConvention": "<string>",
  "jurisdictionCode": "<string>",
  "principalAmount": "<string>",
  "startDate": "<string>",
  "termMonths": 300,
  "gracePeriodDays": 182
}
'
import requests

url = "https://lender.sandbox.lerian.net/api/v1/loan-applications/preview-schedule"

payload = {
"annualInterestRate": "<string>",
"dayCountConvention": "<string>",
"jurisdictionCode": "<string>",
"principalAmount": "<string>",
"startDate": "<string>",
"termMonths": 300,
"gracePeriodDays": 182
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
annualInterestRate: '<string>',
dayCountConvention: '<string>',
jurisdictionCode: '<string>',
principalAmount: '<string>',
startDate: '<string>',
termMonths: 300,
gracePeriodDays: 182
})
};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-applications/preview-schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://lender.sandbox.lerian.net/api/v1/loan-applications/preview-schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'annualInterestRate' => '<string>',
'dayCountConvention' => '<string>',
'jurisdictionCode' => '<string>',
'principalAmount' => '<string>',
'startDate' => '<string>',
'termMonths' => 300,
'gracePeriodDays' => 182
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://lender.sandbox.lerian.net/api/v1/loan-applications/preview-schedule"

payload := strings.NewReader("{\n \"annualInterestRate\": \"<string>\",\n \"dayCountConvention\": \"<string>\",\n \"jurisdictionCode\": \"<string>\",\n \"principalAmount\": \"<string>\",\n \"startDate\": \"<string>\",\n \"termMonths\": 300,\n \"gracePeriodDays\": 182\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://lender.sandbox.lerian.net/api/v1/loan-applications/preview-schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"annualInterestRate\": \"<string>\",\n \"dayCountConvention\": \"<string>\",\n \"jurisdictionCode\": \"<string>\",\n \"principalAmount\": \"<string>\",\n \"startDate\": \"<string>\",\n \"termMonths\": 300,\n \"gracePeriodDays\": 182\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://lender.sandbox.lerian.net/api/v1/loan-applications/preview-schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"annualInterestRate\": \"<string>\",\n \"dayCountConvention\": \"<string>\",\n \"jurisdictionCode\": \"<string>\",\n \"principalAmount\": \"<string>\",\n \"startDate\": \"<string>\",\n \"termMonths\": 300,\n \"gracePeriodDays\": 182\n}"

response = http.request(request)
puts response.read_body
{
  "calendarReference": "<string>",
  "dayCountConvention": "<string>",
  "installments": [
    {
      "dueDate": "<string>",
      "interestAmount": "<string>",
      "number": 123,
      "principalAmount": "<string>",
      "remainingBalance": "<string>",
      "totalAmount": "<string>"
    }
  ],
  "jurisdictionCode": "<string>",
  "profileVersion": "<string>",
  "totalInterest": "<string>",
  "totalPrincipal": "<string>",
  "effectiveCostPreview": {
    "effectiveCostAnnualPct": "<string>",
    "effectiveCostMonthlyPct": "<string>",
    "memoryOfCalculation": {},
    "methodId": "<string>",
    "rateTableSnapshot": {}
  },
  "jurisdictionExtensions": {
    "body": {},
    "overlayKey": "<string>"
  }
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
annualInterestRate
string
required

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

Example:

"0.12000000"

dayCountConvention
string
required

Day count convention identifier.

Example:

"ACT/365"

jurisdictionCode
string
required

ISO-2 jurisdiction code.

Required string length: 2
Example:

"BR"

principalAmount
string
required

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

Example:

"50000.00"

startDate
string
required

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

Example:

"2026-06-14T00:00:00Z"

termMonths
integer<int64>
required

Number of months.

Required range: 1 <= x <= 600
Example:

24

gracePeriodDays
integer<int64>

Grace period in days.

Required range: 0 <= x <= 365
Example:

30

Response

OK

calendarReference
string
required

Identifier of the business calendar used to resolve due dates.

dayCountConvention
string
required

Day count convention applied to interest accrual.

Example:

"ACT/365"

installments
object[] | null
required

Ordered amortisation schedule, one entry per installment.

jurisdictionCode
string
required

ISO-2 jurisdiction code resolved for this preview.

Example:

"BR"

profileVersion
string
required

Jurisdiction profile version used to compute the schedule.

Example:

"1.0.0"

totalInterest
string
required

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

Example:

"4321.00"

totalPrincipal
string
required

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

Example:

"50000.00"

effectiveCostPreview
object

Effective-cost breakdown; present only when the jurisdiction profile computes one.

jurisdictionExtensions
object

Per-jurisdiction overlay payload; present only when the profile emits one.