Record money a written-off borrower paid

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-loss-recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1200.00",
  "receivedAt": "2027-04-15T13:00:00Z"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"amount\": \"1200.00\",\n  \"receivedAt\": \"2027-04-15T13:00:00Z\"\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({amount: '1200.00', receivedAt: '2027-04-15T13:00:00Z'})
};

fetch('https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-loss-recoveries', 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/br/loan-accounts/{id}/credit-loss-recoveries"

payload = {
    "amount": "1200.00",
    "receivedAt": "2027-04-15T13:00:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "amount": "9000.00",
  "controlReleased": "8650.00",
  "currency": "BRL",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receivedAt": "2023-11-07T05:31:56Z",
  "recordedAt": "2023-11-07T05:31:56Z",
  "recordedBy": "<string>",
  "recoveredBefore": "1200.00",
  "remainingAfter": "1400.00",
  "requestId": "<string>",
  "taxAmount": "16.28",
  "taxedAmount": "350.00",
  "untaxedAmount": "8650.00",
  "writeOffId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reversedAt": "2023-11-07T05:31:56Z",
  "reversedBy": "<string>"
}

{
  "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"
  }
}

{
  "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"
  }
}

Record money a written-off borrower paid

Settles the debt a write-off left standing (Res. CMN 4.966 art. 49) with money the borrower paid later, in one transaction; the contract stays written off. The money first pays the written-off amount W, untaxed, and releases the write-off control by that part; what exceeds W is new revenue, taxed by PIS/COFINS (Lei 9.718 art. 3 par. 2 II). An amount above the remaining debt is refused (LENDER-0979) with remainingDebt. The recovery is dated by receivedAt, which must not be before the instant of the write-off nor the day of the latest standing recovery (LENDER-0976): recoveries are recorded in money order, so the split and the tax fall in the right month; a recovery that was reversed no longer counts, which is the way out of an out-of-order day. Keyed on X-Idempotency alone: the same key with the same amount and receivedAt replays the recovery and moves nothing; the same key with another body is refused (LENDER-0978).

POST

api

loan-accounts

{id}

credit-loss-recoveries

Record money a written-off borrower paid

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-loss-recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1200.00",
  "receivedAt": "2027-04-15T13:00:00Z"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"amount\": \"1200.00\",\n  \"receivedAt\": \"2027-04-15T13:00:00Z\"\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({amount: '1200.00', receivedAt: '2027-04-15T13:00:00Z'})
};

fetch('https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-loss-recoveries', 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/br/loan-accounts/{id}/credit-loss-recoveries"

payload = {
    "amount": "1200.00",
    "receivedAt": "2027-04-15T13:00:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "amount": "9000.00",
  "controlReleased": "8650.00",
  "currency": "BRL",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "receivedAt": "2023-11-07T05:31:56Z",
  "recordedAt": "2023-11-07T05:31:56Z",
  "recordedBy": "<string>",
  "recoveredBefore": "1200.00",
  "remainingAfter": "1400.00",
  "requestId": "<string>",
  "taxAmount": "16.28",
  "taxedAmount": "350.00",
  "untaxedAmount": "8650.00",
  "writeOffId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reversedAt": "2023-11-07T05:31:56Z",
  "reversedBy": "<string>"
}

{
  "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"
  }
}

{
  "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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency

string

Idempotency key of the recovery: 1 to 255 bytes of UTF-8. The route refuses a request without it, or with a blank, longer or non-UTF-8 one (LENDER-0976). X-Request-ID is never read as the key.

Path Parameters

string<uuid>

required

Written-off direct-credit loan account.

Body

application/json

amount

string

Money received: a positive decimal string with at most 2 decimal places. A repeat of the same X-Idempotency key must carry the same amount and receivedAt.

Example:

"1200.00"

receivedAt

string

RFC 3339 instant the money arrived; its São Paulo day dates the entry. Not after today and not before the write-off instant.

Example:

"2027-04-15T13:00:00Z"

Response

Created

amount

string

required

Money received (2 d.p. string).

Example:

"9000.00"

controlReleased

string

required

Written-off control the recovery released (2 d.p. string).

Example:

"8650.00"

currency

string

required

ISO 4217 currency of the amounts.

Example:

"BRL"

string<uuid>

required

Recorded recovery.

loanAccountId

string<uuid>

required

Written-off loan account.

receivedAt

string<date-time>

required

RFC 3339 instant the money arrived, with fractional seconds.

recordedAt

string<date-time>

required

RFC 3339 instant the recovery was recorded.

recordedBy

string

required

Subject of the validated identity that recorded it; empty when none reached the route.

recoveredBefore

string

required

Recovered by the recoveries recorded before this one (2 d.p. string).

Example:

"1200.00"

remainingAfter

string

required

Debt still standing after this recovery (2 d.p. string).

Example:

"1400.00"

requestId

string

required

X-Idempotency key the recovery was recorded under.

taxAmount

string

required

PIS/COFINS booked on the taxed part; 0.00 when nothing is taxed (2 d.p. string).

Example:

"16.28"

taxedAmount

string

required

Part above W: new revenue, taxed by PIS/COFINS (2 d.p. string).

Example:

"350.00"

untaxedAmount

string

required

Part that settles the written-off amount W first: untaxed (2 d.p. string).

Example:

"8650.00"

writeOffId

string<uuid>

required

Write-off the recovery pays down.

reversedAt

string<date-time>

RFC 3339 instant the recovery was reversed, with fractional seconds; absent while it stands. A reversed recovery no longer counts in recoveredTotal, remainingDebt or controlOpen.

reversedBy

string

Subject that reversed it.

Brazil loan products

Consignado operations

Loan product lifecycle

Product versions

Product configuration

Floating-rate tables

Document templates

Loan Applications

Credit instruments

Regulatory disclosures and risk

Payoff and prepayment

Write-offs and credit-loss recovery

Account overview and audit

Charges and schedule

Repayments

Transactions

Returned payment receivables

Assignment funds

Assignment sets

Assignment exceptions and dossiers

Accounting

Portfolio dashboards

Jurisdictions

Tax

Partner access

Session

Business date

Streaming

Error handling

Events

Record money a written-off borrower paid

Authorizations

Headers

Path Parameters

Body

Response