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 repayment is a transaction posted against an active loan. The API exposes LMS’s transaction surface: regular repayments, interest waivers, recoveries, refunds, and adjustments or reversals of existing transactions. All repayment endpoints are nested under a loan: /v1/loans/{loan_id}/repayments/....

​
The repayment object

​
id
string
Unique transaction identifier.
​
loanId
string
The loan this transaction belongs to.
​
type
string
Transaction type label. Common values: Repayment, Foreclosure, Waive Interest, Recovery Repayment, Refund, Charge-off.
​
date
string
ISO-8601 YYYY-MM-DD. Date the transaction was effective.
​
amount
number
Total transaction amount.
​
principal
number
Portion of the amount applied to principal.
​
interest
number
Portion applied to interest.
​
fees
number
Portion applied to fees.
​
penalties
number
Portion applied to penalties.
​
overpaymentPortion
number
Overpayment amount (if the transaction exceeded the outstanding balance).
​
reversed
boolean
Whether this transaction has been manually reversed.
​
externalId
string
Optional client-assigned correlation ID.

​
Endpoints

MethodPathPurpose
POST/v1/loans/{loan_id}/repaymentsRepay — installment or partial prepayment
POST/v1/loans/{loan_id}/repayments/waive-interestWaive interest currently due
POST/v1/loans/{loan_id}/repayments/recoverRecover — recovery payment on a written-off loan
POST/v1/loans/{loan_id}/repayments/refundRefund — refund-by-cash
POST/v1/loans/{loan_id}/repayments/charge-offCharge off the loan
GET/v1/loans/{loan_id}/repayments/{transaction_id}Get a transaction
POST/v1/loans/{loan_id}/repayments/{transaction_id}/adjustAdjust an existing transaction
POST/v1/loans/{loan_id}/repayments/{transaction_id}/reverseReverse a transaction

​
Common request body

Endpoints that create a new transaction (repay, waive-interest, recover, refund, charge-off) share the same request body shape:
​
transactionDate
string
required
ISO-8601 YYYY-MM-DD.
​
transactionAmount
number
required
Must be greater than 0.
​
paymentTypeId
integer
Optional. LMS payment-type code (cash, bank transfer, etc.).
​
accountNumber
string
​
checkNumber
string
​
routingCode
string
​
receiptNumber
string
​
bankNumber
string
​
note
string
Optional free-text note.
​
externalId
string
Optional client-assigned correlation ID for idempotency.
Reverse takes a different body — see its page. The per-endpoint pages note any semantic differences in how the transaction is applied.