Loans

Loan reads, balances, and withdrawals

Loan routes expose contract details, balances, transactions, withdrawals, and OTP-based withdrawal confirmation flows.

Read endpoints

MethodRouteResponse
GET/api/Loan/get-loan/{loanId}LoanResponse
GET/api/Loan/get-customer-loans/{customerId}List of LoanResponse
GET/api/Loan/get-transactions/{loanId}Transaction list
GET/api/Loan/get-transactions-paged/{loanId}PagedListTransactionResponse
GET/api/Loan/get-withdrawals/{loanId}PagedListAdvanceProjectionResponse
GET/api/Loan/get-contract-documents/{loanId}Contract document list
GET/api/Loan/get-total-balance/{loanId}LoanBalanceResponse
GET/api/Loan/get-repayment-balances/{loanId}DashboardLoanRepaymentResponse
GET/api/Loan/is-loan-enabled/{loanId}bool
GET/api/Loan/is-loan-closed/{loanId}bool
GET/api/Loan/get-early-repayment/{loanId}Early repayment response

Public list routes that accept take are capped at 200 records per request.

Withdrawal flow

MethodRouteInputResponse
POST/api/Loan/make-withdrawal-line-of-credit/{loanId}LineOfCreditWithdrawalRequestLineOfCreditWithdrawalResponse
POST/api/Loan/confirm-withdrawal-line-of-credit/{loanId}WithdrawLineRequestApiResponse<T>
POST/api/Loan/make-withdrawal-invoice/{loanId}InvoiceWithdrawalRequestInvoiceWithdrawalResponse
POST/api/Loan/confirm-withdrawal-invoice/{loanId}WithdrawInvoiceRequestDataApiResponse<T>
POST/api/Loan/resend-withdrawal-otp/{loanId}Route paramGuid

Validation highlights

Line-of-credit confirmation requires positive amount, advanceRate, dateUTC, and terms between 7 and 52.

Invoice withdrawal confirmation requires amount, advanceRate, dateUTC, and otp.

The current line-of-credit confirm validator does not explicitly require otp, but client integrations should still send it.