Submit a loan application or calculate its schedule
/lokta-lms/api/v1/loansIt calculates the loan repayment Schedule
Submits a new loan application
Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType
Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, allowPartialPeriodInterestCalculation, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing
Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate
Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate
Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables
When to use it
Use this once the client exists and you have chosen a loan product. The same endpoint also calculates the loan repayment schedule.
Worth knowing
- The application starts unapproved. Approve it, then disburse it, with the commands on the loan resource.
Query parameters
commandquery · string · optionalcommand
Request body application/json
allowFullTermForTrancheboolean · optionalAllow full term length for each tranche disbursement
amortizationTypeinteger · int32 · optionalbuyDownFeeCalculationTypestring · optionalFLATbuyDownFeeIncomeTypestring · optionalFEE, INTERESTbuyDownFeeStrategystring · optionalEQUAL_AMORTIZATIONcapitalizedIncomeCalculationTypestring · optionalFLATcapitalizedIncomeStrategystring · optionalEQUAL_AMORTIZATIONcapitalizedIncomeTypeStringEnumOptionData · optionalchargesarray of PostLoansRequestChargeData · optionalclientIdinteger · int64 · optionaldatatablesarray of PostLoansDataTable · optionaldateFormatstring · optionaldaysInYearCustomStrategystring · optionalFULL_LEAP_YEAR, FEB_29_PERIOD_ONLYdaysInYearTypeinteger · int32 · optionaldisbursedAmountPercentageForDownPaymentnumber · optionaldisbursementDataarray of PostLoansDisbursementData · optionalList of PostLoansDisbursementData
enableAutoRepaymentForDownPaymentboolean · optionalenableBuyDownFeeboolean · optionalenableDownPaymentboolean · optionalenableIncomeCapitalizationboolean · optionalenableInstallmentLevelDelinquencyboolean · optionalexpectedDisbursementDatestring · optionalexternalIdstring · optionalfixedEmiAmountnumber · optionalfixedLengthinteger · int32 · optionalfixedPrincipalPercentagePerInstallmentnumber · optionalgraceOnArrearsAgeinginteger · int32 · optionalgraceOnInterestChargedinteger · int32 · optionalgraceOnInterestPaymentinteger · int32 · optionalgraceOnPrincipalPaymentinteger · int32 · optionalinArrearsTolerancenumber · optionalinterestCalculationPeriodTypeinteger · int32 · optionalinterestRateFrequencyTypeinteger · int32 · optionalinterestRatePerPeriodnumber · optionalinterestRecognitionOnDisbursementDateboolean · optionalinterestTypeinteger · int32 · optionalloanScheduleProcessingTypestring · optionalloanTermFrequencyinteger · int32 · optionalloanTermFrequencyTypeinteger · int32 · optionalloanTypestring · optionallocalestring · optionalmaxOutstandingLoanBalancenumber · optionalMaximum allowed outstanding balance
numberOfRepaymentsinteger · int32 · optionalprincipalnumber · optionalproductIdinteger · int64 · optionalrepaymentEveryinteger · int32 · optionalrepaymentFrequencyTypeinteger · int32 · optionalrepaymentStartDateTypeinteger · int32 · optionalrepaymentsStartingFromDatestring · date · optionalsubmittedOnDatestring · optionaltransactionProcessingStrategyCodestring · optionalResponses
200OKResponse fields
clientIdinteger · int64 · optionalcurrencyGetLoansLoanIdCurrency · optionalcurrency
loanIdinteger · int64 · optionalloanTermInDaysinteger · int32 · optionalofficeIdinteger · int64 · optionalperiodsarray of PostLoansRepaymentSchedulePeriods · optionalresourceExternalIdstring · optionalresourceIdinteger · int64 · optionaltotalFeeChargesChargedinteger · int64 · optionaltotalInterestChargednumber · optionaltotalOutstandinginteger · int64 · optionaltotalPenaltyChargesChargedinteger · int64 · optionaltotalPrincipalDisbursedinteger · int64 · optionaltotalPrincipalExpectedinteger · int64 · optionaltotalPrincipalPaidinteger · int64 · optionaltotalRepaymentinteger · int64 · optionaltotalRepaymentExpectednumber · optionaltotalWaivedinteger · int64 · optionaltotalWrittenOffinteger · int64 · optionalEvery 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.
This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai