Reverse loan account transaction

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "jurisdictionCode": "BR",
  "profileVersion": "1.0.0"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"jurisdictionCode\": \"BR\",\n  \"profileVersion\": \"1.0.0\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>', jurisdictionCode: 'BR', profileVersion: '1.0.0'})
};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse"

payload = {
    "reason": "<string>",
    "jurisdictionCode": "BR",
    "profileVersion": "1.0.0"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amount": "125.00",
  "destination": "revived",
  "effectiveDate": "2026-06-14",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "originalTransactionId": "550e8400-e29b-41d4-a716-446655440001",
  "profileVersion": "1.0.0",
  "reason": "<string>",
  "transactionId": "550e8400-e29b-41d4-a716-446655440002",
  "jurisdictionCode": "BR",
  "requestId": "550e8400-e29b-41d4-a716-446655440010",
  "returnedPaymentReceivableId": "550e8400-e29b-41d4-a716-446655440003"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Reverse loan account transaction

Creates an immutable compensating transaction and preserves reversal lineage. The reversal’s effective date is DERIVED from the payment being reversed and is not accepted in the request; a body carrying effectiveDate is refused 422. Idempotency is enforced in the use case via the X-Request-ID header (X-Idempotency fallback): a reused request ID with different facts yields 409. A malformed UUID yields 422; an unknown transaction yields 404; a payment already reversed yields 409. A reversal is REFUSED 422 when the loan account carries a payment or a schedule version whose effective timestamp is strictly later than the reversed payment’s. The problem document names which fact blocks, in errors[0].message: REVERSAL_REFUSED_LATER_PAYMENT (the borrower paid again — use the compensating-adjustment path), REVERSAL_REFUSED_LATER_SCHEDULE_VERSION (the schedule was re-agreed — the remedy is a new schedule version), or REVERSAL_REFUSED_LATER_FACTS_EXIST (both).

POST

api

loan-accounts

{id}

transactions

{transactionId}

reverse

Reverse loan account transaction

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "jurisdictionCode": "BR",
  "profileVersion": "1.0.0"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"jurisdictionCode\": \"BR\",\n  \"profileVersion\": \"1.0.0\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>', jurisdictionCode: 'BR', profileVersion: '1.0.0'})
};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse"

payload = {
    "reason": "<string>",
    "jurisdictionCode": "BR",
    "profileVersion": "1.0.0"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "amount": "125.00",
  "destination": "revived",
  "effectiveDate": "2026-06-14",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "originalTransactionId": "550e8400-e29b-41d4-a716-446655440001",
  "profileVersion": "1.0.0",
  "reason": "<string>",
  "transactionId": "550e8400-e29b-41d4-a716-446655440002",
  "jurisdictionCode": "BR",
  "requestId": "550e8400-e29b-41d4-a716-446655440010",
  "returnedPaymentReceivableId": "550e8400-e29b-41d4-a716-446655440003"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Request-ID

string

Canonical idempotency request ID. Falls back to X-Idempotency when absent.

Exemplo:

"550e8400-e29b-41d4-a716-446655440010"

X-Idempotency

string

Fallback idempotency request ID used when X-Request-ID is absent.

Exemplo:

"550e8400-e29b-41d4-a716-446655440011"

Parâmetros de caminho

string<uuid>

obrigatório

Loan account identifier (UUID).

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

transactionId

string<uuid>

obrigatório

Original repayment transaction identifier (UUID).

Exemplo:

"550e8400-e29b-41d4-a716-446655440001"

Corpo

application/json

reason

string

obrigatório

Operator-supplied reversal reason.

Minimum string length: 1

jurisdictionCode

string

Optional jurisdiction code.

Exemplo:

"BR"

profileVersion

string

Product profile version applied to the reversal.

Exemplo:

"1.0.0"

Resposta

amount

string

obrigatório

Reversed amount (2 d.p. string).

Exemplo:

"125.00"

destination

enum<string>

obrigatório

Where the reversed money went: 'revived' (the debt returned to this contract, its schedule is back) or 'returned_payment_receivable' (the contract stayed discharged and the money opened a separate debt of the borrower, outside the credit operation and with no payroll deduction behind it).

Opções disponíveis:

revived,

returned_payment_receivable

Exemplo:

"revived"

effectiveDate

string

obrigatório

ISO-8601 effective date of the reversal.

Exemplo:

"2026-06-14"

loanAccountId

string

obrigatório

Loan account UUID.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

originalTransactionId

string

obrigatório

Reversed original transaction UUID.

Exemplo:

"550e8400-e29b-41d4-a716-446655440001"

profileVersion

string

obrigatório

Product profile version applied to the reversal.

Exemplo:

"1.0.0"

reason

string

obrigatório

Operator-supplied reversal reason.

transactionId

string

obrigatório

Compensating reversal transaction UUID.

Exemplo:

"550e8400-e29b-41d4-a716-446655440002"

jurisdictionCode

string

Jurisdiction code applied to the reversal.

Exemplo:

"BR"

requestId

string

Idempotency request ID echoed from the request.

Exemplo:

"550e8400-e29b-41d4-a716-446655440010"

returnedPaymentReceivableId

string<uuid>

Identifier of the returned-payment receivable this reversal opened. Present only when destination is 'returned_payment_receivable'.

Exemplo:

"550e8400-e29b-41d4-a716-446655440003"

Produtos de empréstimo do Brasil

Operações de consignado

Ciclo de vida do produto

Versões do produto

Configuração do produto

Tabelas de taxa flutuante

Modelos de documento

Solicitações de Empréstimo

Instrumentos de crédito

Informações regulatórias e risco

Quitação e pré-pagamento

Visão geral e auditoria da conta

Encargos e cronograma

Pagamentos

Transações

Recebíveis de pagamento devolvido

Fundos de cessão

Lotes de cessão

Exceções e registradora da cessão

Contabilidade

Painéis da carteira

Jurisdições

Impostos

Sessão

Streaming

Tratamento de erros

Eventos

Reverse loan account transaction

Autorizações

Cabeçalhos

Parâmetros de caminho

Corpo

Resposta