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

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

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

string<uuid>

obrigatório

Returned-payment receivable identifier.

Exemplo:

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

Resposta

amount

string

obrigatório

Amount owed (2 d.p. string).

Exemplo:

"125.00"

borrowerId

string<uuid>

obrigatório

Party who owes the returned money.

Exemplo:

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

currency

string

obrigatório

ISO-4217 currency of the debt.

Exemplo:

"BRL"

string<uuid>

obrigatório

Returned-payment receivable identifier.

Exemplo:

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

loanAccountId

string<uuid>

obrigatório

Loan account whose returned payment opened this debt. The contract itself stays discharged.

Exemplo:

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

openedAt

string

obrigatório

RFC 3339 UTC instant the debt was opened.

Exemplo:

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

openedOn

string

obrigatório

Civil day the debt was opened on.

Exemplo:

"2026-06-14"

originalTransactionId

string

obrigatório

Payment that was given back.

Exemplo:

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

provisionAmount

string

obrigatório

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.

Exemplo:

"4.38"

reversalTransactionId

string

obrigatório

Compensating reversal that opened this debt.

Exemplo:

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

status

enum<string>

obrigatório

'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.

Opções disponíveis:

open,

collected,

written_off

Exemplo:

"open"

collectedAt

string

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

Exemplo:

"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.

Exemplo:

"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.

Exemplo:

"stage_1"

writtenOffAt

string

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

Exemplo:

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

writtenOffOn

string

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

Exemplo:

"2026-09-01"

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

Get returned payment receivable

Autorizações

Parâmetros de caminho

Resposta