Get returned payment receivable

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/returned-payment-receivables/{id} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/returned-payment-receivables/{id}"

	req, _ := http.NewRequest("GET", 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: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://lender.sandbox.lerian.net/api/v1/returned-payment-receivables/{id}', 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/returned-payment-receivables/{id}"

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

response = requests.get(url, headers=headers)

print(response.text)

{
  "amount": "125.00",
  "borrowerId": "550e8400-e29b-41d4-a716-446655440020",
  "currency": "BRL",
  "id": "550e8400-e29b-41d4-a716-446655440003",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "openedAt": "2026-06-14T12:00:00Z",
  "openedOn": "2026-06-14",
  "originalTransactionId": "550e8400-e29b-41d4-a716-446655440001",
  "provisionAmount": "4.38",
  "reversalTransactionId": "550e8400-e29b-41d4-a716-446655440002",
  "status": "open",
  "collectedAt": "2026-07-01T12:00:00Z",
  "collectedBy": "<string>",
  "collectedOn": "2026-07-01",
  "stage": "stage_1",
  "writtenOffAt": "2026-09-01T05:00:00Z",
  "writtenOffOn": "2026-09-01"
}

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

GET

api

returned-payment-receivables

{id}

Get returned payment receivable

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/returned-payment-receivables/{id} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/returned-payment-receivables/{id}"

	req, _ := http.NewRequest("GET", 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: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://lender.sandbox.lerian.net/api/v1/returned-payment-receivables/{id}', 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/returned-payment-receivables/{id}"

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

response = requests.get(url, headers=headers)

print(response.text)

{
  "amount": "125.00",
  "borrowerId": "550e8400-e29b-41d4-a716-446655440020",
  "currency": "BRL",
  "id": "550e8400-e29b-41d4-a716-446655440003",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "openedAt": "2026-06-14T12:00:00Z",
  "openedOn": "2026-06-14",
  "originalTransactionId": "550e8400-e29b-41d4-a716-446655440001",
  "provisionAmount": "4.38",
  "reversalTransactionId": "550e8400-e29b-41d4-a716-446655440002",
  "status": "open",
  "collectedAt": "2026-07-01T12:00:00Z",
  "collectedBy": "<string>",
  "collectedOn": "2026-07-01",
  "stage": "stage_1",
  "writtenOffAt": "2026-09-01T05:00:00Z",
  "writtenOffOn": "2026-09-01"
}

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

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

string<uuid>

requerido

Returned-payment receivable identifier.

Ejemplo:

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

Respuesta

amount

string

requerido

Amount owed (2 d.p. string).

Ejemplo:

"125.00"

borrowerId

string<uuid>

requerido

Party who owes the returned money.

Ejemplo:

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

currency

string

requerido

ISO-4217 currency of the debt.

Ejemplo:

"BRL"

string<uuid>

requerido

Returned-payment receivable identifier.

Ejemplo:

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

loanAccountId

string<uuid>

requerido

Loan account whose payment reversal opened this debt. The reversal reopens that contract; the debt is collected apart from it.

Ejemplo:

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

openedAt

string

requerido

RFC 3339 UTC instant the debt was opened.

Ejemplo:

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

openedOn

string

requerido

Civil day the debt was opened on.

Ejemplo:

"2026-06-14"

originalTransactionId

string

requerido

Payment that was given back.

Ejemplo:

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

provisionAmount

string

requerido

Credit-loss allowance the ledger holds against this debt right now (2 d.p. string). Zero on a collected debt, which released it, and on a written-off one, which consumed it.

Ejemplo:

"4.38"

reversalTransactionId

string

requerido

Compensating reversal that opened this debt.

Ejemplo:

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

status

enum<string>

requerido

'open' while the borrower still owes it, 'collected' once it was paid by other means, 'written_off' once the ladder charged it off to loss.

Opciones disponibles:

open,

collected,

written_off

Ejemplo:

"open"

collectedAt

string

RFC 3339 UTC instant of the collection; absent while open.

Ejemplo:

"2026-07-01T12:00:00Z"

collectedBy

string

Authenticated subject that recorded the collection; empty when the collection was recorded by the system.

collectedOn

string

Civil day of the collection; absent while open.

Ejemplo:

"2026-07-01"

stage

string

Where the origin credit product's stage ladder put the debt at its last aging. The vocabulary belongs to the jurisdiction publishing the ladder; absent until the first nightly sweep reaches the row.

Ejemplo:

"stage_1"

writtenOffAt

string

RFC 3339 UTC instant of the charge-off; absent unless written off.

Ejemplo:

"2026-09-01T05:00:00Z"

writtenOffOn

string

Civil day of the charge-off; absent unless written off.

Ejemplo:

"2026-09-01"

Productos de préstamo de Brasil

Operaciones de consignado

Ciclo de vida del producto

Versiones del producto

Configuración del producto

Tablas de tasa flotante

Plantillas de documento

Solicitudes de Préstamo

Garantías

Instrumentos de crédito

Divulgaciones regulatorias y riesgo

Liquidación y prepago

Bajas contables y recuperación de crédito

Resumen y auditoría de cuenta

Cargos y calendario

Pagos

Transacciones

Cuentas por cobrar de pago devuelto

Fondos de cesión

Lotes de cesión

Excepciones y dossiers de la cesión

Contabilidad

Paneles de cartera

Jurisdicciones

Impuestos

Acceso de socios

Sesión

Fecha de negocio

Streaming

Manejo de errores

Eventos

Get returned payment receivable

Autorizaciones

Parámetros de ruta

Respuesta