Get payoff statement

GET /api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id}

Get payoff statement

cURL

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id} \
  --header 'Authorization: Bearer <token>'

200

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

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id · string<uuid> · requerido

quote_id · string<uuid> · requerido

Respuesta

200

application/json

OK

accruedInterest · string · requerido

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 · requerido

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 · requerido

currency · string · requerido

expiresAt · string<date-time> · requerido

fees · string · requerido

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

grossAmount · string · requerido

heldCashApplied · string · requerido

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 · requerido

iofReconciliation · string · requerido

lateCharges · string · requerido

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

loanAccountId · string<uuid> · requerido

netAmount · string · requerido

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 · requerido

quoteId · string<uuid> · requerido

slaDueAt · string<date-time> · requerido

slaStatus · enum<string> · requerido

Opciones disponibles: pending, met, breached

statementAvailableAt · string<date-time> · requerido

instrument · object

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

Show child attributes