Skip to main content
GET
List loan products
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

Response

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).
The term is also what fixes a loan’s due instant: a loan on this product is due exactly 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