Reverse a recovery of a written-off contract

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-loss-recoveries/{recoveryId}/reverse \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")

	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>'}};

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

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, 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"
  }
}

Reverse a recovery of a written-off contract

Gives a recovery back, once, in one transaction: the revenue it booked, the PIS/COFINS it booked on its taxed part exactly as booked, and the write-off control it released, all dated by the server on its business date, never by the money day. Only the newest standing recovery reverses (LENDER-0958), so the split of the others never changes; the way out of an out-of-order money day is to reverse the newest recovery and record both in order. A recovery that released control cannot reverse once the control left the books at the end of collection (LENDER-0959); one recorded after it gave back revenue and tax only. The bank reference stays with the reversed recovery: sending it again replays that recovery, so recording the money again needs another reference. Keyed on X-Idempotency per recovery: the same key replays the reversal and moves nothing; another key on a reversed recovery is refused (LENDER-0957).

POST

api

loan-accounts

{id}

credit-loss-recoveries

{recoveryId}

reverse

Reverse a recovery of a written-off contract

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/credit-loss-recoveries/{recoveryId}/reverse \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")

	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>'}};

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

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, 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"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency

string

Idempotency key of the reversal: 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.

Parâmetros de caminho

string<uuid>

obrigatório

Written-off direct-credit loan account.

recoveryId

string<uuid>

obrigatório

Recovery to give back.

Resposta

Created

amount

string

obrigatório

Money received (2 d.p. string).

Exemplo:

"9000.00"

controlReleased

string

obrigatório

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

Exemplo:

"8650.00"

currency

string

obrigatório

ISO 4217 currency of the amounts.

Exemplo:

"BRL"

string<uuid>

obrigatório

Recorded recovery.

loanAccountId

string<uuid>

obrigatório

Written-off loan account.

receivedAt

string<date-time>

obrigatório

RFC 3339 instant the money arrived, with fractional seconds.

recordedAt

string<date-time>

obrigatório

RFC 3339 instant the recovery was recorded.

recordedBy

string

obrigatório

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

recoveredBefore

string

obrigatório

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

Exemplo:

"1200.00"

remainingAfter

string

obrigatório

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

Exemplo:

"1400.00"

requestId

string

obrigatório

X-Idempotency key the recovery was recorded under.

taxAmount

string

obrigatório

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

Exemplo:

"16.28"

taxedAmount

string

obrigatório

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

Exemplo:

"350.00"

untaxedAmount

string

obrigatório

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

Exemplo:

"8650.00"

writeOffId

string<uuid>

obrigatório

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.

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

Baixas contábeis e recuperação de crédito

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 dossiês da cessão

Contabilidade

Painéis da carteira

Jurisdições

Impostos

Acesso de parceiros

Sessão

Data de negócio

Streaming

Tratamento de erros

Eventos

Reverse a recovery of a written-off contract

Autorizações

Cabeçalhos

Parâmetros de caminho

Resposta