API Search endpoints…⌘K

Significant Loan Transactions

POST/lokta-lms/api/v1/loans/{loanId}/transactions

This API covers the major loan transaction functionality

Example Requests:

loans/1/transactions?command=repayment | Make a Repayment |
loans/1/transactions?command=merchantIssuedRefund | Merchant Issued Refund |
loans/1/transactions?command=payoutRefund | Payout Refund |
loans/1/transactions?command=goodwillCredit | Goodwil Credit |
loans/1/transactions?command=chargeRefund | Charge Refund |
loans/1/transactions?command=waiveinterest | Waive Interest |
loans/1/transactions?command=writeoff | Write-off Loan |
loans/1/transactions?command=close-rescheduled | Close Rescheduled Loan |
loans/1/transactions?command=close | Close Loan |
loans/1/transactions?command=undowriteoff | Undo Loan Write-off |
loans/1/transactions?command=recoverypayment | Make Recovery Payment |
loans/1/transactions?command=refundByCash | Make a Refund of an Active Loan by Cash |
loans/1/transactions?command=foreclosure | Foreclosure of an Active Loan |
loans/1/transactions?command=creditBalanceRefund | Credit Balance Refund |
loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=charge-off | Charge-off Loan |
loans/1/transactions?command=downPayment | Down Payment |

Path parameters

loanIdpath · integer · int64 · required

loanId

Query parameters

commandquery · string · optional

command

Request body application/json

accountNumberstring · optional
bankNumberstring · optional
chargeOffReasonIdinteger · int64 · optional
checkNumberstring · optional
classificationIdinteger · int64 · optional
dateFormatstring · optional
dueDatestring · optional
externalIdstring · optional
frequencyNumberinteger · int32 · optional
frequencyTypestring · optional
interestRefundCalculationboolean · optional

Optional. Controls whether Interest Refund transaction should be created for this refund. If not provided, loan product config is used.

loanChargeIdinteger · int64 · optional
localestring · optional
notestring · optional
numberOfInstallmentsinteger · int32 · optional
paymentTypeIdinteger · int64 · optional
reAgeInterestHandlingstring · optional
reAmortizationInterestHandlingstring · optional
reasonCodeValueIdinteger · int64 · optional
receiptNumberstring · optional
reversalExternalIdstring · optional
routingCodestring · optional
startDatestring · optional
transactionAmountnumber · double · optional
transactionDatestring · optional
writeoffReasonIdinteger · int64 · optional

Responses

200OK

Response fields

changesPostLoansLoanIdTransactionsResponseChanges · optional
clientIdinteger · int64 · optional
loanIdinteger · int64 · optional
officeIdinteger · int64 · optional
resourceExternalIdstring · optional
resourceIdinteger · int64 · optional
subResourceExternalIdstring · optional
subResourceIdinteger · int64 · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.