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

# Ingest the collection agent's Arquivo de Baixa Extraordinária

> Accepts the file in which the client's collection agent declares what it received into its own account, against the instructions the lender issued. Identity is the file's CONTENT: the same file re-uploaded is inert and reduces no debt twice. The file's own header names the agent, and a file this tenant cannot attribute to anybody — neither its active channel nor an agent still holding an open instruction — is refused before a single line is stored. Accepting the file applies nothing: each line becomes durable work, applied independently, so one unrecognised instruction is quarantined for an operator instead of blocking every other borrower's payment in the same upload. A line declaring a receipt the agent cannot have taken yet — a paid instant more than a few minutes ahead of the moment we receive the file — is refused too, and refuses the whole file: that instant is the ACCOUNTING instant of the settlement, so a skewed clock or a broken date formatter would book a repayment in the future.



## OpenAPI

````yaml /en/openapi/v3-current/lender.yaml post /api/v1/br/consignado/collection-settlements
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). See
    docs/contracts/money-route-idempotency.md.
  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.
    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.
    name: Consignado
  - description: >-
      Credit-instrument document template registry: versioned drafting and
      publication of CCB clausulado.
    name: DocumentTemplates
paths:
  /api/v1/br/consignado/collection-settlements:
    post:
      tags:
        - Consignado
      summary: Ingest the collection agent's Arquivo de Baixa Extraordinária
      description: >-
        Accepts the file in which the client's collection agent declares what it
        received into its own account, against the instructions the lender
        issued. Identity is the file's CONTENT: the same file re-uploaded is
        inert and reduces no debt twice. The file's own header names the agent,
        and a file this tenant cannot attribute to anybody — neither its active
        channel nor an agent still holding an open instruction — is refused
        before a single line is stored. Accepting the file applies nothing: each
        line becomes durable work, applied independently, so one unrecognised
        instruction is quarantined for an operator instead of blocking every
        other borrower's payment in the same upload. A line declaring a receipt
        the agent cannot have taken yet — a paid instant more than a few minutes
        ahead of the moment we receive the file — is refused too, and refuses
        the whole file: that instant is the ACCOUNTING instant of the
        settlement, so a skewed clock or a broken date formatter would book a
        repayment in the future.
      operationId: ingestConsignadoCollectionSettlements
      parameters:
        - description: >-
            Canonical idempotency request ID. Required: this request moves
            money, and without a key a retry cannot be told apart from a second
            instruction.
          in: header
          name: X-Idempotency
          required: true
          schema:
            description: >-
              Canonical idempotency request ID. Required: this request moves
              money, and without a key a retry cannot be told apart from a
              second instruction.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IngestCollectionSettlementHumaInputBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionSettlementIngestHumaBody'
          description: Accepted
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '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
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    IngestCollectionSettlementHumaInputBody:
      additionalProperties: false
      properties:
        content:
          description: >-
            The collection agent's Arquivo de Baixa Extraordinária,
            base64-encoded, exactly as received. Its sha-256 is the file's
            identity: the same file re-uploaded changes nothing and reduces no
            debt twice.
          format: byte
          minLength: 1
          type: string
      required:
        - content
      type: object
    CollectionSettlementIngestHumaBody:
      additionalProperties: false
      properties:
        agentName:
          description: >-
            The collection agent the file came from. Checked before anything was
            stored: it has to be this tenant's active channel, or the agent an
            instruction still open was issued to.
          type: string
        currency:
          description: ISO 4217 currency code.
          type: string
        fileDigest:
          description: >-
            sha-256 of exactly the ingested bytes — the identity a re-upload is
            recognised by.
          type: string
        layoutVersion:
          description: The layout the bytes were parsed under, recorded on every line.
          type: string
        lineCount:
          description: Settlements the file carries.
          format: int64
          type: integer
        replayed:
          description: >-
            True when every line of this file was already known and nothing was
            written.
          type: boolean
        storedCount:
          description: >-
            Settlements this upload durably added. Zero on a re-upload: every
            line was already known and nothing was applied a second time.
          format: int64
          type: integer
        totalPaid:
          description: Total the file declares, cent scale, decimal string; never a float.
          type: string
      required:
        - fileDigest
        - layoutVersion
        - agentName
        - lineCount
        - storedCount
        - totalPaid
        - currency
        - replayed
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
    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

````