Preview a repayment schedule
curl --request POST \
--url https://{baasHost}/api/v1/lms/loans/calculate-schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"productCode": "<string>",
"principal": 123,
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numberOfRepayments": 123,
"repaymentEvery": 123,
"interestRatePerPeriod": 123,
"expectedDisbursementDate": "<string>",
"linkWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createWalletProductCode": "<string>",
"fspFundId": 123
}
'import requests
url = "https://{baasHost}/api/v1/lms/loans/calculate-schedule"
payload = {
"productCode": "<string>",
"principal": 123,
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numberOfRepayments": 123,
"repaymentEvery": 123,
"interestRatePerPeriod": 123,
"expectedDisbursementDate": "<string>",
"linkWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createWalletProductCode": "<string>",
"fspFundId": 123
}
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({
productCode: '<string>',
principal: 123,
customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
numberOfRepayments: 123,
repaymentEvery: 123,
interestRatePerPeriod: 123,
expectedDisbursementDate: '<string>',
linkWalletId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
createWalletProductCode: '<string>',
fspFundId: 123
})
};
fetch('https://{baasHost}/api/v1/lms/loans/calculate-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://{baasHost}/api/v1/lms/loans/calculate-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([
'productCode' => '<string>',
'principal' => 123,
'customerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'numberOfRepayments' => 123,
'repaymentEvery' => 123,
'interestRatePerPeriod' => 123,
'expectedDisbursementDate' => '<string>',
'linkWalletId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'createWalletProductCode' => '<string>',
'fspFundId' => 123
]),
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://{baasHost}/api/v1/lms/loans/calculate-schedule"
payload := strings.NewReader("{\n \"productCode\": \"<string>\",\n \"principal\": 123,\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"numberOfRepayments\": 123,\n \"repaymentEvery\": 123,\n \"interestRatePerPeriod\": 123,\n \"expectedDisbursementDate\": \"<string>\",\n \"linkWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createWalletProductCode\": \"<string>\",\n \"fspFundId\": 123\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://{baasHost}/api/v1/lms/loans/calculate-schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"productCode\": \"<string>\",\n \"principal\": 123,\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"numberOfRepayments\": 123,\n \"repaymentEvery\": 123,\n \"interestRatePerPeriod\": 123,\n \"expectedDisbursementDate\": \"<string>\",\n \"linkWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createWalletProductCode\": \"<string>\",\n \"fspFundId\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baasHost}/api/v1/lms/loans/calculate-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 \"productCode\": \"<string>\",\n \"principal\": 123,\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"numberOfRepayments\": 123,\n \"repaymentEvery\": 123,\n \"interestRatePerPeriod\": 123,\n \"expectedDisbursementDate\": \"<string>\",\n \"linkWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createWalletProductCode\": \"<string>\",\n \"fspFundId\": 123\n}"
response = http.request(request)
puts response.read_body{
"currency": {
"code": "TZS",
"decimalPlaces": 2
},
"periods": [
{
"period": 1,
"dueDate": "2026-04-15",
"principalDue": 33333.33,
"interestDue": 2500,
"totalDueForPeriod": 35833.33
}
]
}Lending
Preview a repayment schedule
Calculates a schedule without creating a loan. Same body as Originate a loan.
POST
/
v1
/
lms
/
loans
/
calculate-schedule
Preview a repayment schedule
curl --request POST \
--url https://{baasHost}/api/v1/lms/loans/calculate-schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"productCode": "<string>",
"principal": 123,
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numberOfRepayments": 123,
"repaymentEvery": 123,
"interestRatePerPeriod": 123,
"expectedDisbursementDate": "<string>",
"linkWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createWalletProductCode": "<string>",
"fspFundId": 123
}
'import requests
url = "https://{baasHost}/api/v1/lms/loans/calculate-schedule"
payload = {
"productCode": "<string>",
"principal": 123,
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numberOfRepayments": 123,
"repaymentEvery": 123,
"interestRatePerPeriod": 123,
"expectedDisbursementDate": "<string>",
"linkWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createWalletProductCode": "<string>",
"fspFundId": 123
}
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({
productCode: '<string>',
principal: 123,
customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
numberOfRepayments: 123,
repaymentEvery: 123,
interestRatePerPeriod: 123,
expectedDisbursementDate: '<string>',
linkWalletId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
createWalletProductCode: '<string>',
fspFundId: 123
})
};
fetch('https://{baasHost}/api/v1/lms/loans/calculate-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://{baasHost}/api/v1/lms/loans/calculate-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([
'productCode' => '<string>',
'principal' => 123,
'customerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'numberOfRepayments' => 123,
'repaymentEvery' => 123,
'interestRatePerPeriod' => 123,
'expectedDisbursementDate' => '<string>',
'linkWalletId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'createWalletProductCode' => '<string>',
'fspFundId' => 123
]),
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://{baasHost}/api/v1/lms/loans/calculate-schedule"
payload := strings.NewReader("{\n \"productCode\": \"<string>\",\n \"principal\": 123,\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"numberOfRepayments\": 123,\n \"repaymentEvery\": 123,\n \"interestRatePerPeriod\": 123,\n \"expectedDisbursementDate\": \"<string>\",\n \"linkWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createWalletProductCode\": \"<string>\",\n \"fspFundId\": 123\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://{baasHost}/api/v1/lms/loans/calculate-schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"productCode\": \"<string>\",\n \"principal\": 123,\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"numberOfRepayments\": 123,\n \"repaymentEvery\": 123,\n \"interestRatePerPeriod\": 123,\n \"expectedDisbursementDate\": \"<string>\",\n \"linkWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createWalletProductCode\": \"<string>\",\n \"fspFundId\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baasHost}/api/v1/lms/loans/calculate-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 \"productCode\": \"<string>\",\n \"principal\": 123,\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"numberOfRepayments\": 123,\n \"repaymentEvery\": 123,\n \"interestRatePerPeriod\": 123,\n \"expectedDisbursementDate\": \"<string>\",\n \"linkWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createWalletProductCode\": \"<string>\",\n \"fspFundId\": 123\n}"
response = http.request(request)
puts response.read_body{
"currency": {
"code": "TZS",
"decimalPlaces": 2
},
"periods": [
{
"period": 1,
"dueDate": "2026-04-15",
"principalDue": 33333.33,
"interestDue": 2500,
"totalDueForPeriod": 35833.33
}
]
}Authorizations
Bearer token from POST /generate-token. Expires ~1h; on 401, re-generate and retry once.
Body
application/json
Loan principal amount (e.g. 100000).
Available options:
DAYS, WEEKS, MONTHS, YEARS yyyy-MM-dd
Strategy B: attach an existing wallet.
Strategy C: auto-provision a wallet + auto-sweep standing instruction. Temporarily unavailable — open a wallet and use linkWalletId instead.
Response
200 - application/json
Schedule preview