Post a loan transaction, such as a repayment

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

This API covers the major loan transaction functionality

Example Requests:

When to use it

Use this to record money movements on a loan. Send command=repayment for a repayment. Other commands cover refunds, waivers, write-offs and foreclosure.

Worth knowing

The body carries transactionDate and transactionAmount, with dateFormat and locale.

Path parameters

loanIdpath · integer · int64 · required

loanId

Query parameters

commandquery · string · optional

command

Request body application/json

accountNumberstring · optional

bankNumberstring · optional

chargeOffReasonIdinteger · int64 · optional

checkNumberstring · optional

classificationIdinteger · int64 · optional

dateFormatstring · optional

dueDatestring · optional

externalIdstring · optional

frequencyNumberinteger · int32 · optional

frequencyTypestring · optional

interestRefundCalculationboolean · optional

Optional. Controls whether Interest Refund transaction should be created for this refund. If not provided, loan product config is used.

loanChargeIdinteger · int64 · optional

localestring · optional

notestring · optional

numberOfInstallmentsinteger · int32 · optional

paymentTypeIdinteger · int64 · optional

reAgeInterestHandlingstring · optional

reAmortizationInterestHandlingstring · optional

reasonCodeValueIdinteger · int64 · optional

receiptNumberstring · optional

reversalExternalIdstring · optional

routingCodestring · optional

startDatestring · optional

transactionAmountnumber · double · optional

transactionDatestring · optional

writeoffReasonIdinteger · int64 · optional

Responses

200OK

Response fields

changesPostLoansLoanIdTransactionsResponseChanges · optional

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}/transactions' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "accountNumber": "acc123", "bankNumber": "ban123", "chargeOffReasonId": 1, "checkNumber": "che123", "classificationId": 1, "dateFormat": "dd MMMM yyyy", "dueDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "frequencyNumber": 1, "frequencyType": "frequencyType" }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/transactions", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "accountNumber": "acc123", "bankNumber": "ban123", "chargeOffReasonId": 1, "checkNumber": "che123", "classificationId": 1, "dateFormat": "dd MMMM yyyy", "dueDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "frequencyNumber": 1, "frequencyType": "frequencyType" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/transactions", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "accountNumber": "acc123", "bankNumber": "ban123", "chargeOffReasonId": 1, "checkNumber": "che123", "classificationId": 1, "dateFormat": "dd MMMM yyyy", "dueDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "frequencyNumber": 1, "frequencyType": "frequencyType" }), }); 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}/transactions")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "accountNumber": "acc123", "bankNumber": "ban123", "chargeOffReasonId": 1, "checkNumber": "che123", "classificationId": 1, "dateFormat": "dd MMMM yyyy", "dueDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "frequencyNumber": 1, "frequencyType": "frequencyType" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "accountNumber": "acc123", "bankNumber": "ban123", "chargeOffReasonId": 1, "checkNumber": "che123", "classificationId": 1, "dateFormat": "dd MMMM yyyy", "dueDate": "28 June 2022", "externalId": "3e7791ce-aa10-11ec-b909-0242ac120002", "frequencyNumber": 1, "frequencyType": "frequencyType" }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/loans/{loanId}/transactions", 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))

{ "changes": { "dateFormat": "dd MMMM yyyy", "externalId": "4ff9b1cb988b7", "locale": "en_GB", "note": "An optional note about why your adjusting or changing the transaction." }, "clientId": 1, "loanId": 1, "officeId": 1 }