> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Get payoff statement ## OpenAPI ````yaml /pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id} openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Code-first OpenAPI 3.1 surface for the Lender service. Routes that move money are at-most-once per X-Idempotency: when one answers 5xx, the X-Idempotency-Fenced response header says whether that key is now refusing resends (true) or free to retry (false or absent). license: name: Lerian Studio General License title: Lender API version: 1.0.0 servers: - url: https://lender.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Caller session projection: validated subject and effective permissions for the presented token. name: Session - description: >- Ledger accounting operations: journal entries and accrual postings for loan accounts. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Accounting - description: >- Loan application intake and lifecycle: submission, decisioning, and status. name: LoanApplications - description: >- Loan product catalog: definition, versioning, and activation of lending products. name: LoanProducts - description: >- Loan account servicing operations: balances, schedules, and account-level actions. name: Loan Accounts - description: >- Portfolio dashboard read operations: aggregated portfolio and performance views. name: Dashboard - description: >- Jurisdiction registry: supported jurisdiction profiles and their capabilities. name: Jurisdictions - description: >- Jurisdiction-specific loan application operations (Brazil origination surface). name: Loan Applications - description: >- Tax computation operations for jurisdiction-specific lending (e.g. Brazil IOF). name: Tax - description: >- Brazil consignado privado operations: contract lifecycle, exclusion repair, and compensating adjustments. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Consignado - description: >- Inbound record quarantine. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Streaming - description: >- Credit-instrument document template registry: versioned drafting and publication of CCB clausulado. name: DocumentTemplates paths: /api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id}: get: tags: - Loan Accounts summary: Get payoff statement operationId: getPayoffStatement parameters: - in: path name: id required: true schema: format: uuid type: string - in: path name: quote_id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PayoffStatementResponse' description: OK '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable '504': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Gateway Timeout default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: PayoffStatementResponse: additionalProperties: false properties: accruedInterest: description: >- 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). type: string amountToRefund: description: >- 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. type: string chargeDiscount: type: string currency: type: string expiresAt: format: date-time type: string fees: description: >- Applied charges the schedule holds open on the payoff day, charged on top of the principal (2 d.p. string). type: string grossAmount: type: string heldCashApplied: description: >- 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). type: string instrument: $ref: '#/components/schemas/PayoffInstrumentResponse' description: >- The charge the borrower pays the payoff through; absent when the held cash covers the payoff. interestDiscount: type: string iofReconciliation: type: string lateCharges: description: >- Late fine and mora open on the payoff day, charged on top of the principal (2 d.p. string). type: string loanAccountId: format: uuid type: string netAmount: description: >- 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. type: string principalOutstanding: type: string quoteId: format: uuid type: string slaDueAt: format: date-time type: string slaStatus: enum: - pending - met - breached type: string statementAvailableAt: format: date-time type: string required: - quoteId - loanAccountId - principalOutstanding - accruedInterest - lateCharges - fees - interestDiscount - chargeDiscount - iofReconciliation - grossAmount - heldCashApplied - netAmount - amountToRefund - currency - statementAvailableAt - slaDueAt - slaStatus - expiresAt type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object PayoffInstrumentResponse: additionalProperties: false properties: boleto: $ref: '#/components/schemas/PayoffBoletoInstructions' id: format: uuid type: string issuedAt: format: date-time type: string pix: $ref: '#/components/schemas/PayoffPIXInstructions' requestedAt: format: date-time type: string status: enum: - requested - issued - paid - expired - cancelled - failed type: string type: enum: - pix - boleto type: string required: - id - type - status - requestedAt type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object PayoffBoletoInstructions: additionalProperties: false properties: barcode: type: string digitableLine: type: string documentUrl: format: uri type: string type: object PayoffPIXInstructions: additionalProperties: false properties: copyPasteCode: type: string qrCodeUrl: format: uri type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.