> ## 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 pending reconciliation transfers

> Lists the transfers that still need a reconciliation action, oldest first.



## OpenAPI

````yaml /pt/openapi/v3-current/ted.yaml get /v1/transfers/reconciliation/pending
openapi: 3.0.3
info:
  title: Bank Transfer (TED) Plugin API
  description: >-
    Complete API for Brazilian bank transfers (TED OUT, TED IN, P2P) through the
    Lerian platform, including transfer initiation, processing, status tracking,
    cancellation, and returns.
  version: 3.4.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
  - OAuth2ClientCredentials:
      - api
  - OAuth2Password:
      - api
tags:
  - name: Transfers API
    description: >-
      Endpoints for initiating, processing, tracking, cancelling, and returning
      transfers.
  - name: Webhooks
    description: >-
      Endpoints for registering and managing tenant-scoped webhook subscriptions
      for transfer events.
  - name: Webhook DLQ
    description: Endpoints for inspecting and retrying webhook dead-letter queue messages.
paths:
  /v1/transfers/reconciliation/pending:
    get:
      tags:
        - Transfers API
      summary: List pending reconciliation transfers
      description: >-
        Lists the transfers that still need a reconciliation action, oldest
        first.
      operationId: listPendingReconciliation
      parameters:
        - $ref: '#/components/parameters/XOrganizationId'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          description: Maximum number of records to return (1–200, default 50).
        - name: reconciliationStatus
          in: query
          required: false
          schema:
            type: string
            enum:
              - AWAITING
              - MANUAL_REVIEW
              - REVERSING
          description: >-
            Lists only the transfers in this reconciliation state. Omit it to
            list every transfer that still needs an action.


            - `AWAITING`: the worker still queries the settlement.

            - `MANUAL_REVIEW`: a person must decide. This includes the transfers
            stored as `EXHAUSTED`.

            - `REVERSING`: an inbound chargeback held on the ledger, retried
            every cycle.
      responses:
        '200':
          description: Pending reconciliation list returned successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: Transfers that still need a reconciliation action.
                    items:
                      type: object
                      properties:
                        transferId:
                          type: string
                          format: uuid
                          example: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d
                        type:
                          type: string
                          example: TED_OUT
                        status:
                          type: string
                          example: PROCESSING
                        controlNumber:
                          type: string
                          nullable: true
                          example: '202602010001'
                        flaggedAt:
                          type: string
                          format: date-time
                          example: '2026-02-01T15:35:00-03:00'
                        failureCode:
                          type: string
                          example: JD_UNAVAILABLE
                        failureClass:
                          type: string
                          example: unknown_state
                        counterpartySystem:
                          type: string
                          example: JD_SPB
                        reconciliationStatus:
                          type: string
                          enum:
                            - AWAITING
                            - EXHAUSTED
                            - MANUAL_REVIEW
                            - REVERSING
                          description: >-
                            The reconciliation state of the transfer, as stored.
                            `EXHAUSTED` has the same meaning as `MANUAL_REVIEW`.
                          example: MANUAL_REVIEW
                        reconciliationAttempts:
                          type: integer
                          description: >-
                            The number of settlement queries already sent.
                            Always present, zero included.
                          example: 5
                        lastReconciliationAttemptAt:
                          type: string
                          format: date-time
                          description: >-
                            The time of the most recent settlement query, when
                            one was sent.
                          example: '2026-02-01T15:40:00Z'
                        settlementRejectionCode:
                          type: string
                          description: >-
                            The rejection code of the clearing house, verbatim,
                            for example `AAC90` or `ALN01`. Absent when there is
                            none.
                          example: ALN01
                  failureConcentration:
                    type: array
                    description: Breakdown of failure codes across pending items.
                    items:
                      type: object
                      properties:
                        failureCode:
                          type: string
                          example: JD_UNAVAILABLE
                        count:
                          type: integer
                          example: 12
                  pagination:
                    type: object
                    description: Pagination metadata.
                    properties:
                      limit:
                        type: integer
                        description: Maximum number of pending transfers requested.
                        example: 50
                      returned:
                        type: integer
                        description: Number of pending transfers returned in this response.
                        example: 25
                      hasNextPage:
                        type: boolean
                        description: >-
                          Whether the returned page filled the requested limit,
                          indicating more items may exist.
                        example: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            BTF-0404: `X-Organization-Id` names an organization that this tenant
            does not operate.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDocument'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  parameters:
    XOrganizationId:
      name: X-Organization-Id
      in: header
      required: true
      description: >-
        Midaz organization scope for the request, used for downstream CRM, Fees,
        and Midaz calls. Required on org-scoped transfer routes in every
        deployment mode; a missing or non-UUID value returns 400. This is not
        the tenant identifier — tenantId is derived from the bearer JWT or
        authenticated context, never from this header. Background workers (TED
        IN poller, reconciliation) have no request header and, in single-tenant
        mode, fall back to the deployment's `ORGANIZATION_ID` env.
      schema:
        type: string
        format: uuid
      example: 019c96a0-0a98-7287-9a31-786e0809c769
  responses:
    BadRequest:
      description: Indicates that the request contains invalid input.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDocument'
          examples:
            invalidInput:
              summary: Validation error
              value:
                type: https://errors.lerian.studio/v1/BTF-0001
                title: Bad Request
                status: 400
                detail: invalid request body
                code: BTF-0001
                category: deterministic
                requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                service: plugin
    Unauthorized:
      description: Indicates that the request is missing a valid authentication token.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDocument'
          examples:
            unauthorized:
              summary: Missing authorization
              value:
                type: https://errors.lerian.studio/v1/BTF-0401
                title: Unauthorized
                status: 401
                detail: Missing Token
                code: BTF-0401
                category: plugin
                requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                service: plugin
    Forbidden:
      description: >-
        Indicates that the caller is authenticated but lacks permission for this
        operation.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDocument'
          examples:
            permissionDenied:
              summary: Caller lacks permission
              value:
                type: https://errors.lerian.studio/v1/BTF-0405
                title: Forbidden
                status: 403
                detail: >-
                  the credential is not allowed to perform transfers:create on
                  this request
                code: BTF-0405
                category: plugin
                requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                service: plugin
    RateLimitExceeded:
      description: >-
        Indicates that the rate limit has been exceeded. Retry after the number
        of seconds specified in the Retry-After header.
      headers:
        Retry-After:
          description: Seconds until rate limit resets
          schema:
            type: integer
            example: 60
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDocument'
          examples:
            rateLimitExceeded:
              summary: Too many requests
              value:
                type: https://errors.lerian.studio/v1/BTF-0429
                title: Too Many Requests
                status: 429
                detail: Rate limit exceeded
                code: BTF-0429
                category: rate_limit
                requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                service: plugin
              description: >
                Rate-limit responses use the dedicated `BTF-0429` code with the
                `rate_limit` category. Clients should back off using the HTTP
                status `429` and the `Retry-After` header.
    InternalServerError:
      description: Indicates that an unexpected internal error occurred.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDocument'
          examples:
            internalError:
              summary: Internal error
              value:
                type: https://errors.lerian.studio/v1/BTF-9000
                title: Internal Server Error
                status: 500
                detail: Internal server error
                code: BTF-9000
                category: plugin
                requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                service: plugin
    ServiceUnavailable:
      description: >-
        Indicates that a dependency of this service is unavailable or is not
        configured in this deployment.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDocument'
          examples:
            repositoryUnavailable:
              summary: Repository unavailable
              value:
                type: https://errors.lerian.studio/v1/BTF-9008
                title: Service Unavailable
                status: 503
                detail: transfer repository unavailable
                code: BTF-9008
                category: transient
                requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                service: plugin
            dlqInspectorUnavailable:
              summary: DLQ inspector not configured
              value:
                type: https://errors.lerian.studio/v1/BTF-9005
                title: Service Unavailable
                status: 503
                detail: DLQ inspector is not configured
                code: BTF-9005
                category: deterministic
                requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                service: plugin
  schemas:
    ProblemDocument:
      type: object
      description: >-
        The RFC 9457 problem document that the service answers every error with,
        on `application/problem+json`. Route-specific members (for example
        `refusalCode`, `transactionId`, `ledgerStatus`, `systemplaneKey`) appear
        flat at the top level beside these.
      additionalProperties: true
      required:
        - type
        - title
        - status
        - detail
        - code
        - requestId
        - service
        - category
      properties:
        type:
          type: string
          description: >-
            A URI that names the error code:
            `https://errors.lerian.studio/v1/<code>`.
          example: https://errors.lerian.studio/v1/BTF-0200
        title:
          type: string
          description: The HTTP status text.
          example: Not Found
        status:
          type: integer
          description: The HTTP status code.
          example: 404
        detail:
          type: string
          description: A human-readable explanation of this occurrence.
          example: transfer not found
        instance:
          type: string
          description: The trace ID of this request, when one was recorded.
          example: 4bf92f3577b34da6a3ce929d0e0e4736
        errors:
          type: array
          description: Each rejected field. Present on field validation errors only.
          items:
            type: object
            properties:
              message:
                type: string
                description: Why the value was rejected.
                example: transferId must be a valid UUID
              location:
                type: string
                description: 'Where the value sits: `body.<field>` or `query.<field>`.'
                example: body.senderAccountId
        code:
          type: string
          description: The stable BTF error code.
          example: BTF-0200
        upstream:
          type: object
          description: >-
            The error that an upstream provider (JD SPB, Midaz) reported. Absent
            unless surfaced.
          properties:
            code:
              type: string
              description: The provider's own error code, verbatim.
              example: AAC90
            message:
              type: string
              description: The provider's own error message, bounded.
              example: Assinatura invalida
        requestId:
          type: string
          description: The request correlation ID. Present even when empty.
          example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
        service:
          type: string
          description: The system that produced the error.
          example: plugin
        category:
          type: string
          description: The machine-readable error category.
          example: deterministic
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token authentication. The tenantId is derived from the bearer
        token or authenticated request context and is not supplied through
        X-Organization-Id.
    OAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /v1/login/oauth/access_token
          scopes:
            api: TED transfer API access
    OAuth2Password:
      type: oauth2
      flows:
        password:
          tokenUrl: /v1/login/oauth/access_token
          scopes:
            api: TED transfer API access

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.