Modify a loan application

PUT/lokta-lms/api/v1/loans/{loanId}

Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method.

Path parameters

loanIdpath · integer · int64 · required

loanId

Query parameters

commandquery · string · optional

command

Request body application/json

allowFullTermForTrancheboolean · optional

Allow full term length for each tranche disbursement

amortizationTypeinteger · int32 · optional

chargesarray of PutLoansLoanIdChargeData · optional

clientIdinteger · int64 · optional

collateralarray of PutLoansLoanIdCollateral · optional

createStandingInstructionAtDisbursementboolean · optional

dateFormatstring · optional

disbursedAmountPercentageForDownPaymentnumber · optional

disbursementDataarray of PutLoansLoanIdDisbursementData · optional

enableAutoRepaymentForDownPaymentboolean · optional

enableDownPaymentboolean · optional

enableInstallmentLevelDelinquencyboolean · optional

expectedDisbursementDatestring · optional

fixedLengthinteger · int32 · optional

fixedPrincipalPercentagePerInstallmentnumber · optional

fraudboolean · optional

graceOnArrearsAgeinginteger · int32 · optional

interestCalculationPeriodTypeinteger · int32 · optional

interestChargedFromDatestring · optional

interestRateFrequencyTypeinteger · int32 · optional

interestRatePerPeriodnumber · optional

interestRecognitionOnDisbursementDateboolean · optional

interestTypeinteger · int32 · optional

isEqualAmortizationboolean · optional

isTopupboolean · optional

linkAccountIdinteger · int64 · optional

loanIdToCloseinteger · int64 · optional

loanScheduleProcessingTypestring · optional

loanTermFrequencyinteger · int32 · optional

loanTermFrequencyTypeinteger · int32 · optional

loanTypestring · optional

localestring · optional

maxOutstandingLoanBalanceinteger · int64 · optional

numberOfRepaymentsinteger · int32 · optional

principalinteger · int64 · optional

productIdinteger · int64 · optional

repaymentEveryinteger · int32 · optional

repaymentFrequencyDayOfWeekTypeinteger · int32 · optional

repaymentFrequencyNthDayTypeinteger · int32 · optional

repaymentFrequencyTypeinteger · int32 · optional

repaymentsStartingFromDatestring · optional

submittedOnDatestring · optional

transactionProcessingStrategyCodestring · optional

Responses

200OK

Response fields

changesPutLoansLoanIdChanges · optional

clientIdinteger · int64 · optional

loanIdinteger · int64 · optional

officeIdinteger · int64 · optional

resourceExternalIdstring · optional

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

curl -X PUT \ 'http://localhost:8080/lokta-lms/api/v1/loans/{loanId}' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "allowFullTermForTranche": false, "amortizationType": 1, "charges": [ { "amount": 1, "chargeCalculationType": 1, "chargeId": 1, "chargePaymentMode": 1 } ], "clientId": 1, "collateral": [ { "clientCollateralId": 1, "quantity": 1 } ], "createStandingInstructionAtDisbursement": true, "dateFormat": "dd MMMM yyyy", "disbursedAmountPercentageForDownPayment": 0, "disbursementData": [ { "dateFormat": "dd MMMM yyyy", "expectedDisbursementDate": "19 August 2026", "interestType": 1, "isEqualAmortization": true } ], "enableAutoRepaymentForDownPayment": false }'

import requests response = requests.put( "http://localhost:8080/lokta-lms/api/v1/loans/{loanId}", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "allowFullTermForTranche": False, "amortizationType": 1, "charges": [ { "amount": 1, "chargeCalculationType": 1, "chargeId": 1, "chargePaymentMode": 1 } ], "clientId": 1, "collateral": [ { "clientCollateralId": 1, "quantity": 1 } ], "createStandingInstructionAtDisbursement": True, "dateFormat": "dd MMMM yyyy", "disbursedAmountPercentageForDownPayment": 0, "disbursementData": [ { "dateFormat": "dd MMMM yyyy", "expectedDisbursementDate": "19 August 2026", "interestType": 1, "isEqualAmortization": True } ], "enableAutoRepaymentForDownPayment": False }, ) print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/loans/{loanId}", { method: "PUT", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "allowFullTermForTranche": false, "amortizationType": 1, "charges": [ { "amount": 1, "chargeCalculationType": 1, "chargeId": 1, "chargePaymentMode": 1 } ], "clientId": 1, "collateral": [ { "clientCollateralId": 1, "quantity": 1 } ], "createStandingInstructionAtDisbursement": true, "dateFormat": "dd MMMM yyyy", "disbursedAmountPercentageForDownPayment": 0, "disbursementData": [ { "dateFormat": "dd MMMM yyyy", "expectedDisbursementDate": "19 August 2026", "interestType": 1, "isEqualAmortization": true } ], "enableAutoRepaymentForDownPayment": false }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:8080/lokta-lms/api/v1/loans/{loanId}")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("PUT", HttpRequest.BodyPublishers.ofString(""" { "allowFullTermForTranche": false, "amortizationType": 1, "charges": [ { "amount": 1, "chargeCalculationType": 1, "chargeId": 1, "chargePaymentMode": 1 } ], "clientId": 1, "collateral": [ { "clientCollateralId": 1, "quantity": 1 } ], "createStandingInstructionAtDisbursement": true, "dateFormat": "dd MMMM yyyy", "disbursedAmountPercentageForDownPayment": 0, "disbursementData": [ { "dateFormat": "dd MMMM yyyy", "expectedDisbursementDate": "19 August 2026", "interestType": 1, "isEqualAmortization": true } ], "enableAutoRepaymentForDownPayment": false } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "allowFullTermForTranche": false, "amortizationType": 1, "charges": [ { "amount": 1, "chargeCalculationType": 1, "chargeId": 1, "chargePaymentMode": 1 } ], "clientId": 1, "collateral": [ { "clientCollateralId": 1, "quantity": 1 } ], "createStandingInstructionAtDisbursement": true, "dateFormat": "dd MMMM yyyy", "disbursedAmountPercentageForDownPayment": 0, "disbursementData": [ { "dateFormat": "dd MMMM yyyy", "expectedDisbursementDate": "19 August 2026", "interestType": 1, "isEqualAmortization": true } ], "enableAutoRepaymentForDownPayment": false }`) req, _ := http.NewRequest("PUT", "http://localhost:8080/lokta-lms/api/v1/loans/{loanId}", payload) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") req.Header.Set("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))