List Loan Products

GET/lokta-lms/api/v1/loanproducts

Lists every loan product configured on the tenant.

Lists Loan Products

Example Requests:

loanproducts

loanproducts?fields=name,description,interestRateFrequencyType,amortizationType

When to use it

Call this to find the productId a loan application needs.

Responses

200OK

Response fields

accountingRuleGetLoanProductsAccountingRule · optional

amortizationTypeGetLoanProductsAmortizationType · optional

annualInterestRatenumber · double · optional

buyDownFeeCalculationTypeStringEnumOptionData · optional

buyDownFeeIncomeTypeStringEnumOptionData · optional

buyDownFeeStrategyStringEnumOptionData · optional

capitalizedIncomeCalculationTypeStringEnumOptionData · optional

capitalizedIncomeStrategyStringEnumOptionData · optional

capitalizedIncomeTypeStringEnumOptionData · optional

chargeOffBehaviourStringEnumOptionData · optional

currencyGetLoanProductsCurrency · optional

daysInMonthTypeGetLoanProductsDaysInMonthType · optional

daysInYearCustomStrategyGetLoanProductsDaysInYearCustomStrategy · optional

daysInYearTypeGetLoanProductsDaysInYearType · optional

enableBuyDownFeeboolean · optional

enableIncomeCapitalizationboolean · optional

endDatestring · date · optional

fixedLengthinteger · int32 · optional

fixedPrincipalPercentagePerInstallmentnumber · optional

idinteger · int64 · optional

includeInBorrowerCycleboolean · optional

interestCalculationPeriodTypeGetLoansProductsInterestCalculationPeriodType · optional

interestRateFrequencyTypeGetLoanProductsInterestRateFrequencyType · optional

interestRatePerPeriodnumber · double · optional

interestRateVariationsForBorrowerCyclearray · optional

interestRecalculationDataGetLoanProductsInterestRecalculationData · optional

interestRecognitionOnDisbursementDateboolean · optional

interestTypeGetLoanProductsInterestType · optional

isInterestRecalculationEnabledboolean · optional

maxNumberOfRepaymentsinteger · int32 · optional

maxPrincipalnumber · double · optional

merchantBuyDownFeeboolean · optional

minNumberOfRepaymentsinteger · int32 · optional

minPrincipalnumber · double · optional

namestring · optional

numberOfRepaymentVariationsForBorrowerCyclearray · optional

numberOfRepaymentsinteger · int32 · optional

principalnumber · double · optional

principalThresholdForLastInstalmentinteger · int32 · optional

principalVariationsForBorrowerCyclearray · optional

repaymentEveryinteger · int32 · optional

repaymentFrequencyTypeGetLoanProductsRepaymentFrequencyType · optional

repaymentStartDateTypeGetLoanProductsRepaymentStartDateType · optional

shortNamestring · optional

startDatestring · date · optional

statusstring · optional

supportedInterestRefundTypesarray of StringEnumOptionData · optional

transactionProcessingStrategystring · optional

transactionProcessingStrategyNamestring · optional

useBorrowerCycleboolean · 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.

This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai