Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.api.bsa.ai/llms.txt

Use this file to discover all available pages before exploring further.

A loan is an extension of credit to a customer. Loans move through a strict lifecycle: 
Submitted → Approved → Disbursed → Active (with repayments) → Closed
Every forward transition has a corresponding reversal:
ForwardReversal
SubmitReject / Withdraw
ApproveUndo approval
DisburseUndo disbursal
(any)Write off the outstanding balance

​
The loan object

​
id
string
Unique loan identifier.
​
accountNo
string
​
externalId
string
​
customerId
string
The customer this loan belongs to.
​
customerName
string
​
loanProductId
string
The product template this loan was created from. See Loan products.
​
loanProductName
string
​
status
string
Lifecycle status. Common values: Submitted and pending approval, Approved, Active, Closed (obligations met), Closed (written off).
​
principal
number
Requested principal amount.
​
approvedPrincipal
number
Approved principal (may differ from requested). Present after approval.
​
currencyCode
string
ISO-4217 currency code, e.g. TZS, USD.
​
termFrequency
integer
Loan term in units of frequency type.
​
numberOfRepayments
integer
How many installments the loan is scheduled across.
​
interestRatePerPeriod
number

​
Endpoints

MethodPathPurpose
POST/v1/loansSubmit a new application
GET/v1/loansList loans (paginated, filterable by customer)
GET/v1/loans/{loan_id}Get one
PUT/v1/loans/{loan_id}Update a pending application
DELETE/v1/loans/{loan_id}Delete (pending only)
POST/v1/loans/{loan_id}/approveApprove
POST/v1/loans/{loan_id}/undo-approvalUndo approval
POST/v1/loans/{loan_id}/rejectReject
POST/v1/loans/{loan_id}/withdrawWithdraw by the applicant
POST/v1/loans/{loan_id}/disburseDisburse
POST/v1/loans/{loan_id}/undo-disbursalUndo disbursal
POST/v1/loans/{loan_id}/writeoffWrite off
For repayment-side operations, see the Repayments section.