Run a command on a loan, such as approve or disburse

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

Approve Loan Application:
Mandatory Fields: approvedOnDate
Optional Fields: approvedLoanAmount and expectedDisbursementDate
Approves the loan application

Undo Loan Application Approval:
Undoes the Loan Application Approval

Assign a Loan Officer:
Allows you to assign Loan Officer for existing Loan.

Unassign a Loan Officer:
Allows you to unassign the Loan Officer.

Reject Loan Application:
Mandatory Fields: rejectedOnDate
Allows you to reject the loan application

Applicant Withdraws from Loan Application:
Mandatory Fields: withdrawnOnDate
Allows the applicant to withdraw the loan application

Disburse Loan:
Mandatory Fields: actualDisbursementDate
Optional Fields: transactionAmount and fixedEmiAmount
Disburses the Loan

Undo Loan Disbursal:
Undoes the Loan Disbursal
Showing request and response for Assign a Loan Officer

When to use it

Use the command query parameter to move the loan through its lifecycle. Send command=approve with approvedOnDate, then command=disburse with actualDisbursementDate. The same URL also rejects, withdraws, assigns officers and undoes approval or disbursal.

Worth knowing

Each command has its own required fields. They are listed in the description below.

Path parameters

loanIdpath · integer · int64 · required

loanId

Query parameters

commandquery · string · optional

command

Request body application/json

actualDisbursementDatestring · optional

adjustRepaymentDatestring · optional

approvedLoanAmountnumber · optional

approvedOnDatestring · optional

assignmentDatestring · optional

dateFormatstring · optional

disbursementDataarray of PostLoansLoanIdDisbursementData · optional

List of PostLoansLoanIdDisbursementData

expectedDisbursementDatestring · optional

externalIdstring · optional

fixedEmiAmountnumber · optional

fromLoanOfficerIdinteger · int64 · optional

localestring · optional

notestring · optional

paymentTypeIdinteger · int32 · optional

rejectedOnDatestring · optional

toLoanOfficerIdinteger · int64 · optional

transactionAmountnumber · optional

unassignedDatestring · optional

withdrawnOnDatestring · optional

Responses

200OK

Response fields

changesPostLoansLoanIdChanges · optional

PostLoansLoanIdChanges

clientIdinteger · int64 · optional

loanIdinteger · int64 · optional

officeIdinteger · int64 · optional

resourceExternalIdstring · optional

resourceIdinteger · int64 · optional

subResourceExternalIdstring · optional

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

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

curl -X POST \ 'https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "actualDisbursementDate": "28 June 2022", "adjustRepaymentDate": "28 July 2022", "approvedLoanAmount": 1000, "approvedOnDate": "28 June 2022", "assignmentDate": "02 September 2014", "dateFormat": "dd MMMM yyyy", "disbursementData": [ { "expectedDisbursementDate": "19 August 2026", "principal": 22000 } ], "expectedDisbursementDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "fixedEmiAmount": 500 }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "actualDisbursementDate": "28 June 2022", "adjustRepaymentDate": "28 July 2022", "approvedLoanAmount": 1000, "approvedOnDate": "28 June 2022", "assignmentDate": "02 September 2014", "dateFormat": "dd MMMM yyyy", "disbursementData": [ { "expectedDisbursementDate": "19 August 2026", "principal": 22000 } ], "expectedDisbursementDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "fixedEmiAmount": 500 }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "actualDisbursementDate": "28 June 2022", "adjustRepaymentDate": "28 July 2022", "approvedLoanAmount": 1000, "approvedOnDate": "28 June 2022", "assignmentDate": "02 September 2014", "dateFormat": "dd MMMM yyyy", "disbursementData": [ { "expectedDisbursementDate": "19 August 2026", "principal": 22000 } ], "expectedDisbursementDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "fixedEmiAmount": 500 }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/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("POST", HttpRequest.BodyPublishers.ofString(""" { "actualDisbursementDate": "28 June 2022", "adjustRepaymentDate": "28 July 2022", "approvedLoanAmount": 1000, "approvedOnDate": "28 June 2022", "assignmentDate": "02 September 2014", "dateFormat": "dd MMMM yyyy", "disbursementData": [ { "expectedDisbursementDate": "19 August 2026", "principal": 22000 } ], "expectedDisbursementDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "fixedEmiAmount": 500 } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "actualDisbursementDate": "28 June 2022", "adjustRepaymentDate": "28 July 2022", "approvedLoanAmount": 1000, "approvedOnDate": "28 June 2022", "assignmentDate": "02 September 2014", "dateFormat": "dd MMMM yyyy", "disbursementData": [ { "expectedDisbursementDate": "19 August 2026", "principal": 22000 } ], "expectedDisbursementDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "fixedEmiAmount": 500 }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/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))