Skip to main content
Originate and service loans. Loans can stand alone or link to a wallet that auto-sweeps repayments (see BNPL).
Requires an active customer (KYC). Bearer token from /generate-token; re-token on 401.

​
Pick a product

curl -s $BRIDGE_URL/v1/lms/products -H "Authorization: Bearer $TOKEN" | jq
Each product carries terms (min/max principal, repayments) and interest. Use the code when creating a loan.

​
Preview the schedule (optional)

Show the customer their installments before committing — no record created. 
curl -s -X POST $BRIDGE_URL/v1/lms/loans/calculate-schedule \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d "{\"customerId\":\"$CUSTOMER_ID\",\"productCode\":\"PERSONAL_LOAN_001\",\"principal\":100000,\"numberOfRepayments\":3,\"repaymentFrequency\":\"MONTHS\"}" | jq

​
Originate → approve → disburse

1

Create the loan

LOAN=$(curl -s -X POST $BRIDGE_URL/v1/lms/loans \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d "{\"customerId\":\"$CUSTOMER_ID\",\"productCode\":\"PERSONAL_LOAN_001\",\"principal\":100000,\"numberOfRepayments\":3,\"repaymentFrequency\":\"MONTHS\",\"expectedDisbursementDate\":\"$(date +%F)\"}")
LOAN_ID=$(echo $LOAN | jq -r .loanId)
Returns { loanId, externalLoanId, state: "PENDING", ... }.
2

Approve

curl -s -X POST $BRIDGE_URL/v1/lms/loans/$LOAN_ID/approve \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d "{\"approvedOnDate\":\"$(date +%F)\",\"note\":\"Credit check passed.\"}"
3

Disburse

# Direct disbursement (no linked wallet):
curl -s -X POST $BRIDGE_URL/v1/lms/loans/$LOAN_ID/disburse \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d "{\"disbursedOnDate\":\"$(date +%F)\"}"
For a wallet-linked loan, use disburse-to-savings instead — see BNPL.

​
Inspect the loan

curl -s $BRIDGE_URL/v1/lms/loans/$LOAN_ID/schedule -H "Authorization: Bearer $TOKEN" | jq

​
Record repayments

Two ways. Verified (recommended) checks the payment on the gateway before posting: 
curl -s -X POST $BRIDGE_URL/v1/lms/loans/$LOAN_ID/submit-payment \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{ "gatewayReference": "MPESA-ABC123XYZ", "amount": 35000, "fspId": "CLICKPESA" }'
Direct records a repayment you’ve already reconciled (receiptNumber is the idempotency key, paymentTypeId from GET /v1/lms/payment-types): 
curl -s -X POST $BRIDGE_URL/v1/lms/loans/$LOAN_ID/repayments \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{ "transactionAmount": 35000, "transactionDate": "2026-04-10", "paymentTypeId": 1, "receiptNumber": "REC-123456" }'

curl -s $BRIDGE_URL/v1/lms/loans/$LOAN_ID/pay-link -H "Authorization: Bearer $TOKEN" | jq -r .payLink

​
Next

Collect the repayment

Trigger a USSD push and post the verified payment to this loan.