List loan products
curl --request GET \
--url https://api-staging.bsa.ai/v1/loan-products \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-staging.bsa.ai/v1/loan-products"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-staging.bsa.ai/v1/loan-products', 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://api-staging.bsa.ai/v1/loan-products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.bsa.ai/v1/loan-products"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.bsa.ai/v1/loan-products")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.bsa.ai/v1/loan-products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"shortName": "<string>",
"description": "<string>",
"currencyCode": "<string>",
"principal": 123,
"minPrincipal": 123,
"maxPrincipal": 123,
"numberOfRepayments": 123,
"repaymentEvery": 123,
"repaymentFrequencyType": "<string>",
"termFrequency": 123,
"termFrequencyType": "<string>",
"interestRatePerPeriod": 123,
"interestRateFrequencyType": "<string>",
"amortizationType": "<string>",
"interestType": "<string>",
"interestCalculationPeriodType": "<string>",
"status": "<string>"
}Loan Products
List loan products
Fetch all configured loan products.
GET
/
v1
/
loan-products
List loan products
curl --request GET \
--url https://api-staging.bsa.ai/v1/loan-products \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-staging.bsa.ai/v1/loan-products"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-staging.bsa.ai/v1/loan-products', 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://api-staging.bsa.ai/v1/loan-products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.bsa.ai/v1/loan-products"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.bsa.ai/v1/loan-products")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.bsa.ai/v1/loan-products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"shortName": "<string>",
"description": "<string>",
"currencyCode": "<string>",
"principal": 123,
"minPrincipal": 123,
"maxPrincipal": 123,
"numberOfRepayments": 123,
"repaymentEvery": 123,
"repaymentFrequencyType": "<string>",
"termFrequency": 123,
"termFrequencyType": "<string>",
"interestRatePerPeriod": 123,
"interestRateFrequencyType": "<string>",
"amortizationType": "<string>",
"interestType": "<string>",
"interestCalculationPeriodType": "<string>",
"status": "<string>"
}Returns every loan product configured in the deployment. Loan products
are administrative templates — partners cannot create or modify them
through this API; they are configured by the operator team.
A loan product defines the constraints and defaults that loans
submitted against it must satisfy: principal range, term, interest
rate, amortization, etc.
The term is also what fixes a loan’s due instant: a loan on this product
is due exactly
Example
curl -sf "$BASE/v1/loan-products" \
-H "Authorization: Bearer $TOKEN"
Response
{
"items": [
{
"id": "1",
"name": "Halotel 7-Day Loan",
"shortName": "H7D",
"description": "7-day loan with 11% flat interest. Pilot product for Halotel mobile lending.",
"currencyCode": "TZS",
"principal": 10000,
"minPrincipal": 1000,
"maxPrincipal": 100000,
"numberOfRepayments": 1,
"repaymentEvery": 7,
"repaymentFrequencyType": "Days",
"termFrequency": 7,
"termFrequencyType": "Days",
"interestRatePerPeriod": 11,
"interestRateFrequencyType": "Whole term",
"amortizationType": "Equal installments",
"interestType": "Flat",
"interestCalculationPeriodType": "Same as repayment period",
"status": "loanProduct.active"
}
]
}
This endpoint returns all products in a single response (no
pagination —
items only, no total/page). Loan-product catalogs
are small; the current deployment has three (7-, 14- and 28-day).
status is the LMS’s own code string (loanProduct.active).termFrequency days after the instant it was disbursed
(dueDateTime on the loan object), and an unpaid loan
is penalised 10% of principal at that instant.
Fields
string
string
string
Short code suitable for display/log lines.
string
string
ISO-4217.
number
Default principal — partners typically override this per loan.
number
number
integer
integer
string
integer
The product’s loan term length (
numberOfRepayments × repaymentEvery), in
units of termFrequencyType — e.g. 7 with termFrequencyType "Days".string
The unit for
termFrequency — "Days", "Weeks", "Months", or "Years".number
string
string
string
string
string

