Retrieve a loan product (draft workflow)
/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 · requiredproductId
Responses
200OKResponse fields
accountingMappingsGetLoanAccountingMappings · optionalaccountingRuleGetLoanProductsAccountingRule · optionalallowApprovedDisbursedAmountsOverAppliedboolean · optionalallowFullTermForTrancheboolean · optionalAllow full term length for each tranche disbursement. Only available for PROGRESSIVE schedule type with multi-disbursement enabled.
allowPartialPeriodInterestCalculationboolean · optionalallowVariableInstallmentsboolean · optionalamortizationTypeGetLoanProductsAmortizationType · optionalannualInterestRatenumber · double · optionalbuyDownFeeCalculationTypeStringEnumOptionData · optionalbuyDownFeeCalculationTypeOptionsarray of StringEnumOptionData · optionalbuyDownFeeIncomeTypeStringEnumOptionData · optionalbuyDownFeeIncomeTypeOptionsarray of StringEnumOptionData · optionalbuyDownFeeStrategyStringEnumOptionData · optionalbuyDownFeeStrategyOptionsarray of StringEnumOptionData · optionalbuydownFeeClassificationOptionsarray of GetCodeValuesDataResponse · optionalbuydownFeeClassificationToIncomeAccountMappingsarray of GetClassificationToIncomeAccountMappings · optionalcanDefineInstallmentAmountboolean · optionalcanUseForTopupboolean · optionalcapitalizedIncomeCalculationTypeStringEnumOptionData · optionalcapitalizedIncomeCalculationTypeOptionsarray of StringEnumOptionData · optionalcapitalizedIncomeClassificationOptionsarray of GetCodeValuesDataResponse · optionalcapitalizedIncomeClassificationToIncomeAccountMappingsarray of GetClassificationToIncomeAccountMappings · optionalcapitalizedIncomeStrategyStringEnumOptionData · optionalcapitalizedIncomeStrategyOptionsarray of StringEnumOptionData · optionalcapitalizedIncomeTypeStringEnumOptionData · optionalcapitalizedIncomeTypeOptionsarray of StringEnumOptionData · optionalchargeOffBehaviourStringEnumOptionData · optionalchargeOffReasonOptionsarray of GetLoanProductsChargeOffReasonOptions · optionalchargeOffReasonToExpenseAccountMappingsarray of GetChargeOffReasonToExpenseAccountMappings · optionalchargesarray of LoanProductV2ChargeEntry · optionalCharge entries with per-association flags (explicit booleans; old associations read false/false).
creditAllocationarray of CreditAllocationData · optionalcurrencyGetLoanProductsCurrency · optionaldaysInMonthTypeGetLoanProductsDaysInMonthType · optionaldaysInYearCustomStrategyStringEnumOptionData · optionaldaysInYearTypeGetLoanProductsDaysInYearType · optionaldelinquencyBucketDelinquencyBucketData · optionaldelinquencyBucketOptionsarray of DelinquencyBucketData · optionaldescriptionstring · optionaldisallowExpectedDisbursementsboolean · optionaldisbursedAmountPercentageForDownPaymentnumber · optionaldueDaysForRepaymentEventinteger · int32 · optionalenableAccrualActivityPostingboolean · optionalenableAutoRepaymentForDownPaymentboolean · optionalenableBuyDownFeeboolean · optionalenableDownPaymentboolean · optionalenableIncomeCapitalizationboolean · optionalenableInstallmentLevelDelinquencyboolean · optionalfeeToIncomeAccountMappingsarray of GetLoanFeeToIncomeAccountMappings · optionalfixedLengthinteger · int32 · optionalfixedPrincipalPercentagePerInstallmentnumber · optionalidinteger · int64 · optionalinArrearsToleranceinteger · int32 · optionalincludeInBorrowerCycleboolean · optionalinterestCalculationPeriodTypeGetLoansProductsInterestCalculationPeriodType · optionalinterestRateFrequencyTypeGetLoanProductsInterestRateFrequencyType · optionalinterestRatePerPeriodnumber · double · optionalinterestRateVariationsForBorrowerCyclearray · optionalinterestRecalculationDataGetLoanProductsInterestRecalculationData · optionalinterestRecognitionOnDisbursementDateboolean · optionalinterestTypeGetLoanProductsInterestTemplateType · optionalisFloatingInterestRateCalculationAllowedboolean · optionalisInterestRecalculationEnabledboolean · optionalisLinkedToFloatingInterestRatesboolean · optionalisRatesEnabledboolean · optionalloanScheduleProcessingTypeEnumOptionData · optionalloanScheduleTypeEnumOptionData · optionalmaxInterestRatePerPeriodnumber · double · optionalmaxNumberOfRepaymentsinteger · int32 · optionalmaxPrincipalnumber · double · optionalmaxTrancheCountinteger · int32 · optionalmaximumGapinteger · int32 · optionalmerchantBuyDownFeeboolean · optionalminInterestRatePerPeriodnumber · double · optionalminNumberOfRepaymentsinteger · int32 · optionalminPrincipalnumber · double · optionalminimumGapinteger · int32 · optionalmultiDisburseLoanboolean · optionalnamestring · optionalnumberOfRepaymentVariationsForBorrowerCyclearray · optionalnumberOfRepaymentsinteger · int32 · optionaloutstandingLoanBalancenumber · double · optionaloverAppliedCalculationTypestring · optionaloverDueDaysForRepaymentEventinteger · int32 · optionaloverdueDaysForNPAinteger · int32 · optionalpaymentAllocationarray of AdvancedPaymentData · optionalpaymentChannelToFundSourceMappingsarray of GetLoanPaymentChannelToFundSourceMappings · optionalprincipalnumber · double · optionalprincipalThresholdForLastInstalmentinteger · int32 · optionalproductsPrincipalVariationsForBorrowerCyclearray of GetLoanProductsPrincipalVariationsForBorrowerCycle · optionalrepaymentEveryinteger · int32 · optionalrepaymentFrequencyTypeGetLoanProductsRepaymentFrequencyType · optionalrepaymentStartDateTypeGetLoanProductsRepaymentStartDateType · optionalshortNamestring · optionalstatusstring · optionalsupportedInterestRefundTypesarray of StringEnumOptionData · optionaltransactionProcessingStrategyCodestring · optionaltransactionProcessingStrategyNamestring · optionaluseBorrowerCycleboolean · optionalwriteOffReasonOptionsarray of GetLoanProductsWriteOffReasonOptions · optionalwriteOffReasonsToExpenseMappingsarray of GetChargeOffReasonToExpenseAccountMappings · optionaladjustedInstallmentRoundingstring · optionalHow the final instalment is rounded when it differs from the others. Absent means the currency's own precision.
beneficiaryTypeLoanProductV2CodeOption · optionalA code-backed value: code is the stable business identifier (supply THIS in write requests), value is the display label.
bpiMethodstring · optionalBPI treatment name; absent when unconfigured.
brokenPeriodDayCountstring · optionalBroken-period convention name; absent means regular-period behaviour.
coLendingEligibleboolean · optionalcollectBpiAtDisbursementboolean · optionalcomputeAprForKfsboolean · optionaldayCountConventionstring · optionalStable 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 · optionalRoundingMode NAME; absent when the product inherits tenant rounding. Internal profile identifiers are never exposed.
interestRateStepnumber · optionalmaximumDaysBetweenDisbursalAndFirstRepaymentinteger · int32 · optionalFirst-repayment ceiling in days; absent when no ceiling is configured.
pmtTypestring · optionalprincipalStepnumber · optionalproductCategoryTagsarray of LoanProductV2CodeOption · optionalproductTypeLoanProductV2CodeOption · optionalA code-backed value: code is the stable business identifier (supply THIS in write requests), value is the display label.
repayOnDayarray · optionalPinned monthly repayment day(s), sorted ascending; absent when none are configured. The internal recurrence rule is never exposed.
repayOnWeekdaystring · optionalThe 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 · optionalWhich 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 · optionalscheduleSolverstring · optionalDeclarative 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.
SOLVE_EMI, TARGET_EMI, MERCHANT_DISCOUNT, FLAT_RATE, TOTAL_INTEREST_PCTtenorStepinteger · int32 · 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