> ## 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. # List collection payments owed back to the portador > Collected money the lender holds because the contract had nothing open to apply it to, oldest receipt first. The client's treasury returns it to the portador by Pix or TED and records that here; the payment then leaves the list. Hold reasons listed: direct_payment_overage, agent_declared_overage, inactive_loan, account_discharged_before_payoff. ## OpenAPI ````yaml /en/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/collection-refunds 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/internal/br/consignado/collection-refunds: get: tags: - Consignado summary: List collection payments owed back to the portador description: >- Collected money the lender holds because the contract had nothing open to apply it to, oldest receipt first. The client's treasury returns it to the portador by Pix or TED and records that here; the payment then leaves the list. Hold reasons listed: direct_payment_overage, agent_declared_overage, inactive_loan, account_discharged_before_payoff. operationId: listConsignadoCollectionRefundsOwed parameters: - description: Page size. explode: false in: query name: limit schema: default: 25 description: Page size. format: int64 maximum: 100 minimum: 1 type: integer - description: Page offset. explode: false in: query name: offset schema: default: 0 description: Page offset. format: int64 maximum: 10000 minimum: 0 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/CollectionRefundOwedListHumaBody' 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: CollectionRefundOwedListHumaBody: additionalProperties: false properties: data: description: Held collection payments owed back, oldest receipt first. items: $ref: '#/components/schemas/CollectionRefundOwedHumaBody' type: - array - 'null' required: - data 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 CollectionRefundOwedHumaBody: additionalProperties: false properties: amountToRefund: description: Amount held and owed back to the portador (2 d.p. string). examples: - '30.00' type: string applicationId: description: The held collection payment; the id the record route takes. format: uuid type: string appliedAmount: description: Amount applied to the contract (2 d.p. string). examples: - '100.00' type: string currency: description: ISO 4217 currency code. type: string loanAccountId: description: Loan account the payment was collected for. format: uuid type: string numeroContrato: description: >- Consignado contract number; empty when the account has no consignado servicing contract. type: string provider: description: The agent or provider that received the money. type: string providerPaymentId: description: Its payment reference, for the treasury to find the payment. type: string receivedAmount: description: Amount collected (2 d.p. string). examples: - '130.00' type: string receivedAt: description: RFC 3339 instant the payment was received. format: date-time type: string repairReason: description: Why the money is held; one of the reasons the operation lists. type: string sourceType: description: What the collected instrument was issued for. enum: - direct_collection - payoff_quote type: string state: description: >- paid_unapplied: nothing was applied; partially_applied: the remainder above what was open is held. enum: - paid_unapplied - partially_applied type: string required: - applicationId - loanAccountId - numeroContrato - sourceType - state - repairReason - receivedAmount - appliedAmount - amountToRefund - currency - provider - providerPaymentId - receivedAt 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 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.