Create a new interest pause period for a loan

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

Allows users to define a period during which no interest will be accrued for a specific loan.

Path parameters

loanIdpath · integer · int64 · required

loanId

Request body application/json

dateFormatstring · optional

Format of the dates provided

endDatestring · optional

End date of the interest pause period

localestring · optional

Locale to interpret the date format

startDatestring · optional

Start date of the interest pause period

Responses

200Command successfully processed

Response fields

changesobject · optional

clientIdinteger · int64 · optional

commandIdinteger · int64 · optional

creditBureauReportDataobject · optional

externalIdOrNullExternalId · optional

loanExternalIdExternalId · optional

loanIdinteger · int64 · optional

officeIdinteger · int64 · optional

productIdinteger · int64 · optional

resourceExternalIdExternalId · optional

resourceIdinteger · int64 · optional

resourceIdentifierstring · optional

rollbackTransactionboolean · optional

subResourceExternalIdExternalId · optional

subResourceIdinteger · int64 · optional

transactionIdstring · 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}/interest-pauses' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "dateFormat": "yyyy-MM-dd", "endDate": "2024-01-11", "locale": "en", "startDate": "2024-01-01" }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/interest-pauses", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "dateFormat": "yyyy-MM-dd", "endDate": "2024-01-11", "locale": "en", "startDate": "2024-01-01" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/interest-pauses", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "dateFormat": "yyyy-MM-dd", "endDate": "2024-01-11", "locale": "en", "startDate": "2024-01-01" }), }); 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}/interest-pauses")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "dateFormat": "yyyy-MM-dd", "endDate": "2024-01-11", "locale": "en", "startDate": "2024-01-01" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "dateFormat": "yyyy-MM-dd", "endDate": "2024-01-11", "locale": "en", "startDate": "2024-01-01" }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/interest-pauses", 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))