> ## 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 funds recoveries

> Returns a paginated list of funds recoveries owned by the requesting participant, newest first by default. The listing is always scoped to the participant (ISPB) resolved from the authenticated tenant context; account_id is an optional accessory filter, not a tenant boundary. modified_after / modified_before are RFC3339 timestamps filtering updatedAt exclusively; start_date / end_date are YYYY-MM-DD dates filtering createdAt inclusively. status and sort_order are case-insensitive. The response echoes the filtered total, the applied page/limit, and hasMore.



## OpenAPI

````yaml /es/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Public API for Pix keys, claims, fraud markers, infraction reports, and MED
    funds recovery. This release provides a mock-provider integration for
    testing; live BACEN connectivity is not included.
  license:
    name: Lerian Studio General License
  title: Pix Lerian — DICT
  version: 1.0.0
servers:
  - url: https://api.example.com/dict-hub/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Manage ownership and portability claims for Pix keys.
    name: Claims
  - description: Register, retrieve, list, update, and remove Pix keys.
    name: Entries
  - description: Create, query, list, and cancel DICT fraud markers.
    name: Fraud Markers
  - description: Manage participant-scoped MED 2.0 funds recoveries.
    name: Funds Recoveries
  - description: Manage MED 2.0 infraction reports for the authenticated organization.
    name: Infraction Reports
  - description: Look up Pix keys and check whether keys exist in the DICT directory.
    name: Keys
  - description: Create, query, cancel, and settle MED 2.0 refunds.
    name: Refunds
paths:
  /dict/funds-recoveries:
    get:
      tags:
        - Funds Recoveries
      summary: List funds recoveries
      description: >-
        Returns a paginated list of funds recoveries owned by the requesting
        participant, newest first by default. The listing is always scoped to
        the participant (ISPB) resolved from the authenticated tenant context;
        account_id is an optional accessory filter, not a tenant boundary.
        modified_after / modified_before are RFC3339 timestamps filtering
        updatedAt exclusively; start_date / end_date are YYYY-MM-DD dates
        filtering createdAt inclusively. status and sort_order are
        case-insensitive. The response echoes the filtered total, the applied
        page/limit, and hasMore.
      operationId: listFundsRecoveries
      parameters:
        - description: >-
            Filter by lifecycle status (case-insensitive): CREATED, TRACKED,
            AWAITING_ANALYSIS, ANALYSED, REFUNDING, COMPLETED, CANCELLED
          explode: false
          in: query
          name: status
          schema:
            description: >-
              Filter by lifecycle status (case-insensitive): CREATED, TRACKED,
              AWAITING_ANALYSIS, ANALYSED, REFUNDING, COMPLETED, CANCELLED
            examples:
              - CREATED
            type: string
        - description: >-
            Filter by situation type: SCAM, ACCOUNT_TAKEOVER, COERCION,
            FRAUDULENT_ACCESS, OTHER, UNKNOWN
          explode: false
          in: query
          name: situation_type
          schema:
            description: >-
              Filter by situation type: SCAM, ACCOUNT_TAKEOVER, COERCION,
              FRAUDULENT_ACCESS, OTHER, UNKNOWN
            examples:
              - SCAM
            type: string
        - description: Filter by the root transaction id
          explode: false
          in: query
          name: root_transaction_id
          schema:
            description: Filter by the root transaction id
            examples:
              - E12345678202605171530aB3xK9mWq2z
            type: string
        - description: Filter by client account UUID within the participant
          explode: false
          in: query
          name: account_id
          schema:
            description: Filter by client account UUID within the participant
            examples:
              - 550e8400-e29b-41d4-a716-446655440000
            type: string
        - description: Return rows updated strictly after this RFC3339 timestamp
          explode: false
          in: query
          name: modified_after
          schema:
            description: Return rows updated strictly after this RFC3339 timestamp
            examples:
              - '2026-05-17T13:30:00Z'
            type: string
        - description: Return rows updated strictly before this RFC3339 timestamp
          explode: false
          in: query
          name: modified_before
          schema:
            description: Return rows updated strictly before this RFC3339 timestamp
            examples:
              - '2026-05-18T13:30:00Z'
            type: string
        - description: Return rows created on or after this date (YYYY-MM-DD)
          explode: false
          in: query
          name: start_date
          schema:
            description: Return rows created on or after this date (YYYY-MM-DD)
            examples:
              - '2026-05-01'
            type: string
        - description: >-
            Return rows created on or before this date (YYYY-MM-DD, inclusive of
            the whole day)
          explode: false
          in: query
          name: end_date
          schema:
            description: >-
              Return rows created on or before this date (YYYY-MM-DD, inclusive
              of the whole day)
            examples:
              - '2026-05-31'
            type: string
        - description: Return rows whose metadata contains this JSON object
          explode: false
          in: query
          name: metadata
          schema:
            description: Return rows whose metadata contains this JSON object
            examples:
              - '{"channel":"mobile"}'
            type: string
        - description: Page number (1-based, default 1)
          explode: false
          in: query
          name: page
          schema:
            description: Page number (1-based, default 1)
            examples:
              - '1'
            type: string
        - description: Maximum items per page (default 10, max 100)
          explode: false
          in: query
          name: limit
          schema:
            description: Maximum items per page (default 10, max 100)
            examples:
              - '10'
            type: string
        - description: >-
            Sort direction by created_at (default desc, case-insensitive): asc
            or desc
          explode: false
          in: query
          name: sort_order
          schema:
            description: >-
              Sort direction by created_at (default desc, case-insensitive): asc
              or desc
            examples:
              - desc
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFundsRecoveriesOutput'
          description: OK
        '400':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0001
                title: Bad Request
                status: 400
                detail: Your request is missing one or more required header params.
                code: PIX-0001
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Bad Request (PIX-0001, PIX-0002, PIX-0003, PIX-0017, PIX-0015,
            PIX-0020).
        '404':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0110
                title: Not Found
                status: 404
                detail: >-
                  No funds recovery exists with the provided ID for this
                  participant.
                code: PIX-0110
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found (PIX-0110).
        '422':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0100
                title: Unprocessable Entity
                status: 422
                detail: Missing or malformed required fields.
                code: PIX-0100
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity (PIX-0100).
        '500':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0000
                title: Internal Server Error
                status: 500
                detail: internal error
                code: PIX-0000
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error (PIX-0000).
        '502':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0141
                title: Bad Gateway
                status: 502
                detail: internal error
                code: PIX-0141
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Gateway (PIX-0141).
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ListFundsRecoveriesOutput:
      additionalProperties: false
      properties:
        hasMore:
          examples:
            - false
          type: boolean
        items:
          items:
            $ref: '#/components/schemas/FundsRecoveryOutput'
          type:
            - array
            - 'null'
        limit:
          examples:
            - 10
          format: int64
          type: integer
        page:
          examples:
            - 1
          format: int64
          type: integer
        total:
          examples:
            - 1
          format: int64
          type: integer
      required:
        - items
        - total
        - page
        - limit
        - hasMore
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
    FundsRecoveryOutput:
      additionalProperties: false
      properties:
        accountId:
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        bacenFundsRecoveryId:
          examples:
            - 9f3a8b7e-2c1d-4e5a-8b6f-1a2b3c4d5e6f
          type: string
        contactInformation:
          $ref: '#/components/schemas/ContactInformationOutput'
        correlationId:
          examples:
            - 7c9e6679742540de944be07fc1f90ae7
          type: string
        createdAt:
          examples:
            - '2026-05-17T13:30:00Z'
          format: date-time
          type: string
        id:
          examples:
            - 018f8c1d-1234-7abc-9def-000000000001
          type: string
        metadata: {}
        participantId:
          examples:
            - '12345678'
          type: string
        reportDetails:
          examples:
            - Victim of a WhatsApp scam
          type: string
        reporterParticipant:
          examples:
            - '12345678'
          type: string
        rootTransactionId:
          examples:
            - E12345678202605171530aB3xK9mWq2z
          type: string
        situationType:
          enum:
            - SCAM
            - ACCOUNT_TAKEOVER
            - COERCION
            - FRAUDULENT_ACCESS
            - OTHER
            - UNKNOWN
          examples:
            - SCAM
          type: string
        status:
          enum:
            - CREATED
            - TRACKED
            - AWAITING_ANALYSIS
            - ANALYSED
            - REFUNDING
            - COMPLETED
            - CANCELLED
          examples:
            - CREATED
          type: string
        trackingGraph: {}
        trackingGraphParameters: {}
        updatedAt:
          examples:
            - '2026-05-17T13:30:00Z'
          format: date-time
          type: string
      required:
        - id
        - bacenFundsRecoveryId
        - participantId
        - accountId
        - rootTransactionId
        - situationType
        - status
        - reporterParticipant
        - contactInformation
        - createdAt
        - updatedAt
      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
    ContactInformationOutput:
      additionalProperties: false
      properties:
        email:
          examples:
            - user@example.com
          type: string
        phone:
          examples:
            - '+5511999999999'
          type: string
      required:
        - email
        - phone
      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.