Reverse a recorded payment

POST/lokta-lms/api/v1/invoices/{invoiceId}/payments/{paymentId}/reversal

Reverses a payment recorded against a partner invoice, with a reason.

reason is required. Append-only: the original payment is never edited or deleted; a contra row carries the negative amount, the reason and its own actor, so sum(amount_paid) stays the one figure every rule reads. The contra is dated today, not back-dated into a period already reported.

An invoice that was paid returns to approved when the reversal leaves it short. A reversal cannot itself be reversed (409 sourcing/payment_not_reversible) and a payment is reversed once (409 sourcing/payment_already_reversed). Record a fresh payment to re-settle.

Path parameters

invoiceIdpath · string · required

paymentIdpath · string · required

Header parameters

Idempotency-Keyheader · string · optional

Per-intent key

Request body application/json

reasonstring · required

Why the payment is being reversed.

Responses

defaultdefault response

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/invoices/{invoiceId}/payments/{paymentId}/reversal' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "reason": "string" }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/invoices/{invoiceId}/payments/{paymentId}/reversal", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "reason": "string" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/invoices/{invoiceId}/payments/{paymentId}/reversal", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "reason": "string" }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/lokta-lms/api/v1/invoices/{invoiceId}/payments/{paymentId}/reversal")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "reason": "string" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "reason": "string" }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/invoices/{invoiceId}/payments/{paymentId}/reversal", 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))