Get payoff statement

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id} \
  --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}/payoff-statements/{quote_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/br/loan-accounts/{id}/payoff-statements/{quote_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/br/loan-accounts/{id}/payoff-statements/{quote_id}"

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

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

print(response.text)

{
  "accruedInterest": "<string>",
  "amountToRefund": "<string>",
  "chargeDiscount": "<string>",
  "currency": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "fees": "<string>",
  "grossAmount": "<string>",
  "heldCashApplied": "<string>",
  "interestDiscount": "<string>",
  "iofReconciliation": "<string>",
  "lateCharges": "<string>",
  "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "netAmount": "<string>",
  "principalOutstanding": "<string>",
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slaDueAt": "2023-11-07T05:31:56Z",
  "slaStatus": "pending",
  "statementAvailableAt": "2023-11-07T05:31:56Z",
  "instrument": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requestedAt": "2023-11-07T05:31:56Z",
    "status": "requested",
    "type": "pix",
    "boleto": {
      "barcode": "<string>",
      "digitableLine": "<string>",
      "documentUrl": "<string>"
    },
    "issuedAt": "2023-11-07T05:31:56Z",
    "pix": {
      "copyPasteCode": "<string>",
      "qrCodeUrl": "<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"
  }
}

GET

api

loan-accounts

{id}

payoff-statements

{quote_id}

Get payoff statement

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id} \
  --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}/payoff-statements/{quote_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/br/loan-accounts/{id}/payoff-statements/{quote_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/br/loan-accounts/{id}/payoff-statements/{quote_id}"

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

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

print(response.text)

{
  "accruedInterest": "<string>",
  "amountToRefund": "<string>",
  "chargeDiscount": "<string>",
  "currency": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "fees": "<string>",
  "grossAmount": "<string>",
  "heldCashApplied": "<string>",
  "interestDiscount": "<string>",
  "iofReconciliation": "<string>",
  "lateCharges": "<string>",
  "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "netAmount": "<string>",
  "principalOutstanding": "<string>",
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slaDueAt": "2023-11-07T05:31:56Z",
  "slaStatus": "pending",
  "statementAvailableAt": "2023-11-07T05:31:56Z",
  "instrument": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requestedAt": "2023-11-07T05:31:56Z",
    "status": "requested",
    "type": "pix",
    "boleto": {
      "barcode": "<string>",
      "digitableLine": "<string>",
      "documentUrl": "<string>"
    },
    "issuedAt": "2023-11-07T05:31:56Z",
    "pix": {
      "copyPasteCode": "<string>",
      "qrCodeUrl": "<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"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

string<uuid>

obrigatório

quote_id

string<uuid>

obrigatório

Resposta

accruedInterest

string

obrigatório

Interest the payoff charges up to its day: accrued and unpaid, less what a standing automatic-prepayment promise earned by then, as the payment that promised an instalment counts at its present value that day (2 d.p. string).

amountToRefund

string

obrigatório

Interest that receipts recorded before the payoff paid for days after its exit, and held cash past what the payoff spent, owed back to the borrower once the payoff is accepted (2 d.p. string). Zero before acceptance. What is still outstanding is on GET /api/v1/br/payoff-refunds-due.

chargeDiscount

string

obrigatório

currency

string

obrigatório

expiresAt

string<date-time>

obrigatório

fees

string

obrigatório

Applied charges the schedule holds open on the payoff day, charged on top of the principal (2 d.p. string).

grossAmount

string

obrigatório

heldCashApplied

string

obrigatório

Cash the contract already held, paid ahead of its due dates, that the payoff spends before asking the borrower for the rest (2 d.p. string).

interestDiscount

string

obrigatório

iofReconciliation

string

obrigatório

lateCharges

string

obrigatório

Late fine and mora open on the payoff day, charged on top of the principal (2 d.p. string).

loanAccountId

string<uuid>

obrigatório

netAmount

string

obrigatório

What the borrower pays: the payoff less the held cash it spends, never below zero (2 d.p. string). At zero no charge is issued and instrument is absent.

principalOutstanding

string

obrigatório

quoteId

string<uuid>

obrigatório

slaDueAt

string<date-time>

obrigatório

slaStatus

enum<string>

obrigatório

Opções disponíveis:

pending,

met,

breached

statementAvailableAt

string<date-time>

obrigatório

instrument

object

The charge the borrower pays the payoff through; absent when the held cash covers the payoff.

Show child attributes

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

Get payoff statement

Autorizações

Parâmetros de caminho

Resposta