Create prepayment quote

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "quoteType": "partial",
  "businessDate": "<string>"
}
'

import requests

url = "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote"

payload = {
    "amount": "<string>",
    "quoteType": "partial",
    "businessDate": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: '<string>', quoteType: 'partial', businessDate: '<string>'})
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '<string>',
    'quoteType' => 'partial',
    'businessDate' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote"

	payload := strings.NewReader("{\n  \"amount\": \"<string>\",\n  \"quoteType\": \"partial\",\n  \"businessDate\": \"<string>\"\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))

}

HttpResponse<String> response = Unirest.post("https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<string>\",\n  \"quoteType\": \"partial\",\n  \"businessDate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"<string>\",\n  \"quoteType\": \"partial\",\n  \"businessDate\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "chargeRebate": "<string>",
  "consumerProtectionRegime": "<string>",
  "createdAt": "<string>",
  "currency": "<string>",
  "expiresAt": "<string>",
  "grossAmount": "<string>",
  "id": "<string>",
  "interestRebate": "<string>",
  "iofReconciliation": "<string>",
  "jurisdictionCode": "<string>",
  "loanAccountId": "<string>",
  "netSettlementAmount": "<string>",
  "principalOutstanding": "<string>",
  "profileVersion": "<string>",
  "quoteType": "<string>",
  "rebateMandatory": true,
  "acceptedAt": "<string>",
  "acceptedTransactionId": "<string>",
  "slaDueAt": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upstream": {
    "code": "<string>",
    "message": "<string>"
  }
}

POST

api

loan-accounts

{id}

prepayment-quote

Create prepayment quote

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "quoteType": "partial",
  "businessDate": "<string>"
}
'

import requests

url = "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote"

payload = {
    "amount": "<string>",
    "quoteType": "partial",
    "businessDate": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: '<string>', quoteType: 'partial', businessDate: '<string>'})
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => '<string>',
    'quoteType' => 'partial',
    'businessDate' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote"

	payload := strings.NewReader("{\n  \"amount\": \"<string>\",\n  \"quoteType\": \"partial\",\n  \"businessDate\": \"<string>\"\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))

}

HttpResponse<String> response = Unirest.post("https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<string>\",\n  \"quoteType\": \"partial\",\n  \"businessDate\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/prepayment-quote")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"<string>\",\n  \"quoteType\": \"partial\",\n  \"businessDate\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "chargeRebate": "<string>",
  "consumerProtectionRegime": "<string>",
  "createdAt": "<string>",
  "currency": "<string>",
  "expiresAt": "<string>",
  "grossAmount": "<string>",
  "id": "<string>",
  "interestRebate": "<string>",
  "iofReconciliation": "<string>",
  "jurisdictionCode": "<string>",
  "loanAccountId": "<string>",
  "netSettlementAmount": "<string>",
  "principalOutstanding": "<string>",
  "profileVersion": "<string>",
  "quoteType": "<string>",
  "rebateMandatory": true,
  "acceptedAt": "<string>",
  "acceptedTransactionId": "<string>",
  "slaDueAt": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upstream": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

string<uuid>

required

Loan account identifier.

Body

application/json

Option 1
Option 2

amount

string

required

Prepayment amount in major currency units (e.g. "100.00").

Example:

"42000.00"

quoteType

enum<string>

required

Discriminator: partial principal prepayment.

Available options:

partial

businessDate

string

Optional valuation date (RFC3339 or YYYY-MM-DD); defaults to now (UTC).

Example:

"2026-06-14"

Response

Created

chargeRebate

string

required

Rebate of unaccrued charges and fees credited on prepayment, as a decimal string, scale 2.

Example:

"120.00"

consumerProtectionRegime

string

required

Consumer-protection regime label applied to the prepayment terms.

createdAt

string

required

RFC3339 UTC timestamp when the quote was created.

Example:

"2026-06-14T12:00:00Z"

currency

string

required

ISO 4217 currency code of the loan and quote.

Example:

"BRL"

expiresAt

string

required

RFC3339 UTC timestamp after which the quote is no longer valid.

Example:

"2026-06-14T12:00:00Z"

grossAmount

string

required

Retired settlement principal being paid off (equals the outstanding principal for a full settlement), as a decimal string, scale 2.

Example:

"42000.00"

string

required

Unique identifier (UUID) of the prepayment quote.

Example:

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

interestRebate

string

required

Mandatory interest rebate (juros nao incorridos) credited on prepayment, as a decimal string, scale 2.

Example:

"1250.75"

iofReconciliation

string

required

IOF adjustment as a decimal string, scale 2. Defined-principal loans report zero because IOF is not refunded on early payoff.

Example:

"0.00"

jurisdictionCode

string

required

ISO jurisdiction code governing the quote (e.g. "BR").

Example:

"BR"

loanAccountId

string

required

UUID of the loan account the quote was generated for.

Example:

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

netSettlementAmount

string

required

Net cash payable to settle: gross settlement principal minus charge rebate plus any IOF due, as a decimal string, scale 2. Interest rebate is disclosure-only; defined-principal loans report zero IOF reconciliation because IOF is not refunded.

Example:

"41880.00"

principalOutstanding

string

required

Outstanding principal at quote time as a decimal string in major currency units, scale 2.

Example:

"42000.00"

profileVersion

string

required

Jurisdiction profile version used to compute the quote.

Example:

"1.0.0"

quoteType

string

required

Quote variant: partial (principal prepayment) or full_settlement.

Example:

"partial"

rebateMandatory

boolean

required

True when regulation mandates applying the interest rebate to this quote.

acceptedAt

string

RFC3339 UTC timestamp when the quote was accepted; empty while still pending.

Example:

"2026-06-14T12:00:00Z"

acceptedTransactionId

string

Identifier of the settlement transaction that accepted the quote; empty while still pending.

Example:

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

slaDueAt

string

RFC3339 UTC full-settlement SLA deadline; omitted for partial quotes.

Example:

"2026-06-19T12:00:00Z"

⌘I

Brazil loan products

Consignado operations

Loan product lifecycle

Product configuration

Loan Applications

Regulatory disclosures and risk

Payoff and prepayment

Account overview and audit

Charges and schedule

Repayments

Transactions

Accounting

Jurisdictions

Tax

Create prepayment quote

Authorizations

Path Parameters

Body

Response