Skip to main content
GET
/
v1
/
loan-products
List loan products
curl --request GET \
  --url https://api.dev.bsa.ai/v1/loan-products \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "shortName": "<string>",
  "description": "<string>",
  "currencyCode": "<string>",
  "principal": 123,
  "minPrincipal": 123,
  "maxPrincipal": 123,
  "numberOfRepayments": 123,
  "repaymentEvery": 123,
  "repaymentFrequencyType": "<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.

​
Example

curl -sf "$BASE/v1/loan-products" \
  -H "Authorization: Bearer $TOKEN"

​
Response

{
  "items": [
    {
      "id": "1",
      "name": "Standard 12-Month",
      "shortName": "STD12",
      "description": "Standard individual loan, 12 months, monthly repayments",
      "currencyCode": "TZS",
      "principal": 5000,
      "minPrincipal": 1000,
      "maxPrincipal": 50000,
      "numberOfRepayments": 12,
      "repaymentEvery": 1,
      "repaymentFrequencyType": "Months",
      "interestRatePerPeriod": 1.5,
      "interestRateFrequencyType": "Per month",
      "amortizationType": "Equal installments",
      "interestType": "Declining Balance",
      "interestCalculationPeriodType": "Same as repayment period",
      "status": "active"
    }
  ]
}
This endpoint returns all products in a single response (no pagination). Loan-product catalogs are small — typically 5–50 items.

​
Fields

​
id
string
​
name
string
​
shortName
string
Short code suitable for display/log lines.
​
description
string
​
currencyCode
string
ISO-4217.
​
principal
number
Default principal — partners typically override this per loan.
​
minPrincipal
number
​
maxPrincipal
number
​
numberOfRepayments
integer
​
repaymentEvery
integer
​
repaymentFrequencyType
string
​
interestRatePerPeriod
number
​
interestRateFrequencyType
string
​
amortizationType
string
​
interestType
string
​
interestCalculationPeriodType
string
​
status
string