API Search endpoints…⌘K Get API credentialsGet access

Retrieve a loan product (draft workflow)

GET/lokta-lms/api/v2/loanproducts/{productId}

Returns one loan product using the V2 response shape.

Retrieves a Loan Product

Example Requests:

v2/loanproducts/1

v2/loanproducts/1?template=true

v2/loanproducts/1?fields=name,description,numberOfRepayments

Path parameters

productIdpath · integer · int64 · required

productId

Responses

200OK

Response fields

accountingMappingsGetLoanAccountingMappings · optional
accountingRuleGetLoanProductsAccountingRule · optional
allowApprovedDisbursedAmountsOverAppliedboolean · optional
allowFullTermForTrancheboolean · optional

Allow full term length for each tranche disbursement. Only available for PROGRESSIVE schedule type with multi-disbursement enabled.

allowPartialPeriodInterestCalculationboolean · optional
allowVariableInstallmentsboolean · optional
amortizationTypeGetLoanProductsAmortizationType · optional
annualInterestRatenumber · double · optional
buyDownFeeCalculationTypeStringEnumOptionData · optional
buyDownFeeCalculationTypeOptionsarray of StringEnumOptionData · optional
buyDownFeeIncomeTypeStringEnumOptionData · optional
buyDownFeeIncomeTypeOptionsarray of StringEnumOptionData · optional
buyDownFeeStrategyStringEnumOptionData · optional
buyDownFeeStrategyOptionsarray of StringEnumOptionData · optional
buydownFeeClassificationOptionsarray of GetCodeValuesDataResponse · optional
buydownFeeClassificationToIncomeAccountMappingsarray of GetClassificationToIncomeAccountMappings · optional
canDefineInstallmentAmountboolean · optional
canUseForTopupboolean · optional
capitalizedIncomeCalculationTypeStringEnumOptionData · optional
capitalizedIncomeCalculationTypeOptionsarray of StringEnumOptionData · optional
capitalizedIncomeClassificationOptionsarray of GetCodeValuesDataResponse · optional
capitalizedIncomeClassificationToIncomeAccountMappingsarray of GetClassificationToIncomeAccountMappings · optional
capitalizedIncomeStrategyStringEnumOptionData · optional
capitalizedIncomeStrategyOptionsarray of StringEnumOptionData · optional
capitalizedIncomeTypeStringEnumOptionData · optional
capitalizedIncomeTypeOptionsarray of StringEnumOptionData · optional
chargeOffBehaviourStringEnumOptionData · optional
chargeOffReasonOptionsarray of GetLoanProductsChargeOffReasonOptions · optional
chargeOffReasonToExpenseAccountMappingsarray of GetChargeOffReasonToExpenseAccountMappings · optional
chargesarray of LoanProductV2ChargeEntry · optional

Charge entries with per-association flags (explicit booleans; old associations read false/false).

creditAllocationarray of CreditAllocationData · optional
currencyGetLoanProductsCurrency · optional
daysInMonthTypeGetLoanProductsDaysInMonthType · optional
daysInYearCustomStrategyStringEnumOptionData · optional
daysInYearTypeGetLoanProductsDaysInYearType · optional
delinquencyBucketDelinquencyBucketData · optional
delinquencyBucketOptionsarray of DelinquencyBucketData · optional
descriptionstring · optional
disallowExpectedDisbursementsboolean · optional
disbursedAmountPercentageForDownPaymentnumber · optional
dueDaysForRepaymentEventinteger · int32 · optional
enableAccrualActivityPostingboolean · optional
enableAutoRepaymentForDownPaymentboolean · optional
enableBuyDownFeeboolean · optional
enableDownPaymentboolean · optional
enableIncomeCapitalizationboolean · optional
enableInstallmentLevelDelinquencyboolean · optional
feeToIncomeAccountMappingsarray of GetLoanFeeToIncomeAccountMappings · optional
fixedLengthinteger · int32 · optional
fixedPrincipalPercentagePerInstallmentnumber · optional
idinteger · int64 · optional
inArrearsToleranceinteger · int32 · optional
includeInBorrowerCycleboolean · optional
interestCalculationPeriodTypeGetLoansProductsInterestCalculationPeriodType · optional
interestRateFrequencyTypeGetLoanProductsInterestRateFrequencyType · optional
interestRatePerPeriodnumber · double · optional
interestRateVariationsForBorrowerCyclearray · optional
interestRecalculationDataGetLoanProductsInterestRecalculationData · optional
interestRecognitionOnDisbursementDateboolean · optional
interestTypeGetLoanProductsInterestTemplateType · optional
isFloatingInterestRateCalculationAllowedboolean · optional
isInterestRecalculationEnabledboolean · optional
isLinkedToFloatingInterestRatesboolean · optional
isRatesEnabledboolean · optional
loanScheduleProcessingTypeEnumOptionData · optional
loanScheduleTypeEnumOptionData · optional
maxInterestRatePerPeriodnumber · double · optional
maxNumberOfRepaymentsinteger · int32 · optional
maxPrincipalnumber · double · optional
maxTrancheCountinteger · int32 · optional
maximumGapinteger · int32 · optional
merchantBuyDownFeeboolean · optional
minInterestRatePerPeriodnumber · double · optional
minNumberOfRepaymentsinteger · int32 · optional
minPrincipalnumber · double · optional
minimumGapinteger · int32 · optional
multiDisburseLoanboolean · optional
namestring · optional
numberOfRepaymentVariationsForBorrowerCyclearray · optional
numberOfRepaymentsinteger · int32 · optional
outstandingLoanBalancenumber · double · optional
overAppliedCalculationTypestring · optional
overDueDaysForRepaymentEventinteger · int32 · optional
overdueDaysForNPAinteger · int32 · optional
paymentAllocationarray of AdvancedPaymentData · optional
paymentChannelToFundSourceMappingsarray of GetLoanPaymentChannelToFundSourceMappings · optional
principalnumber · double · optional
principalThresholdForLastInstalmentinteger · int32 · optional
productsPrincipalVariationsForBorrowerCyclearray of GetLoanProductsPrincipalVariationsForBorrowerCycle · optional
repaymentEveryinteger · int32 · optional
repaymentFrequencyTypeGetLoanProductsRepaymentFrequencyType · optional
repaymentStartDateTypeGetLoanProductsRepaymentStartDateType · optional
shortNamestring · optional
statusstring · optional
supportedInterestRefundTypesarray of StringEnumOptionData · optional
transactionProcessingStrategyCodestring · optional
transactionProcessingStrategyNamestring · optional
useBorrowerCycleboolean · optional
writeOffReasonOptionsarray of GetLoanProductsWriteOffReasonOptions · optional
writeOffReasonsToExpenseMappingsarray of GetChargeOffReasonToExpenseAccountMappings · optional
adjustedInstallmentRoundingstring · optional

How the final instalment is rounded when it differs from the others. Absent means the currency's own precision.

beneficiaryTypeLoanProductV2CodeOption · optional

A code-backed value: code is the stable business identifier (supply THIS in write requests), value is the display label.

bpiMethodstring · optional

BPI treatment name; absent when unconfigured.

brokenPeriodDayCountstring · optional

Broken-period convention name; absent means regular-period behaviour.

coLendingEligibleboolean · optional
collectBpiAtDisbursementboolean · optional
computeAprForKfsboolean · optional
dayCountConventionstring · optional

Stable convention name; absent when the product was configured through raw axes only (a convention is never inferred backwards; 30/360 would be ambiguous between D30_360_US and D30E_360).

defaultRoundingModestring · optional

RoundingMode NAME; absent when the product inherits tenant rounding. Internal profile identifiers are never exposed.

interestRateStepnumber · optional
maximumDaysBetweenDisbursalAndFirstRepaymentinteger · int32 · optional

First-repayment ceiling in days; absent when no ceiling is configured.

pmtTypestring · optional
principalStepnumber · optional
productCategoryTagsarray of LoanProductV2CodeOption · optional
productTypeLoanProductV2CodeOption · optional

A code-backed value: code is the stable business identifier (supply THIS in write requests), value is the display label.

repayOnDayarray · optional

Pinned monthly repayment day(s), sorted ascending; absent when none are configured. The internal recurrence rule is never exposed.

repayOnWeekdaystring · optional

The weekday a contractual product collects on (MO..SU). Mutually exclusive with repayOnDay. On a monthly product it needs repayOnWeekdayOccurrence alongside it; on a weekly product every occurrence of the weekday is a collection.

repayOnWeekdayOccurrenceinteger · int32 · optional

Which occurrence of repayOnWeekday in the month a monthly product collects on: 1 to 4 counting from the start of the month, or -1 for the last. Refused on a weekly product.

residualEnabledboolean · optional
scheduleSolverstring · optional

Declarative solver selection; the canonical enum name when configured; ABSENT when not configured (nullable, no default: existing and V1-created products carry no value). Never an id, never a display label. Informational for the configurator/LOS only: no backend calculation reads it.

One of: SOLVE_EMI, TARGET_EMI, MERCHANT_DISCOUNT, FLAT_RATE, TOTAL_INTEREST_PCT
tenorStepinteger · int32 · 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