> ## 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 Refund Requests

> Use this endpoint to list refund requests with filters and pagination. Returns empty array [] if no requests match the criteria.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/refund-requests
openapi: 3.1.0
info:
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  title: Pix BTG API
  version: 1.12.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/dict/refund-requests:
    get:
      tags:
        - Refund Requests
      summary: List Refund Requests
      description: >-
        Use this endpoint to list refund requests with filters and pagination.
        Returns empty array [] if no requests match the criteria.
      operationId: dict-get-all-refunds
      parameters:
        - description: 'Maximum number of items per page (default: 10, range: 1-100)'
          explode: false
          in: query
          name: limit
          schema:
            default: 10
            description: 'Maximum number of items per page (default: 10, range: 1-100)'
            format: int64
            type: integer
        - description: 'Page number for pagination (default: 1, minimum: 1)'
          explode: false
          in: query
          name: page
          schema:
            default: 1
            description: 'Page number for pagination (default: 1, minimum: 1)'
            format: int64
            type: integer
        - description: 'Sort direction for results: asc or desc'
          explode: false
          in: query
          name: sort_order
          schema:
            default: asc
            description: 'Sort direction for results: asc or desc'
            type: string
        - description: Filter by original Pix transaction ID (32 characters)
          explode: false
          in: query
          name: transaction_id
          schema:
            description: Filter by original Pix transaction ID (32 characters)
            type: string
        - description: >-
            Filter by refund status (comma-separated for OR match): OPEN,
            CLOSED, CANCELLED
          explode: false
          in: query
          name: status
          schema:
            description: >-
              Filter by refund status (comma-separated for OR match): OPEN,
              CLOSED, CANCELLED
            items:
              type: string
            type: array
        - description: >-
            Filter by requesting participant ISPB (8 uppercase alphanumeric
            characters)
          explode: false
          in: query
          name: requesting_participant
          schema:
            description: >-
              Filter by requesting participant ISPB (8 uppercase alphanumeric
              characters)
            type: string
        - description: >-
            Filter by contested participant ISPB (8 uppercase alphanumeric
            characters)
          explode: false
          in: query
          name: contested_participant
          schema:
            description: >-
              Filter by contested participant ISPB (8 uppercase alphanumeric
              characters)
            type: string
        - description: Filter by related infraction report ID (UUID)
          explode: false
          in: query
          name: infraction_id
          schema:
            description: Filter by related infraction report ID (UUID)
            format: uuid
            type: string
        - description: >-
            Filter by refund analysis result: TOTALLY_ACCEPTED,
            PARTIALLY_ACCEPTED, REJECTED
          explode: false
          in: query
          name: analysis_result
          schema:
            description: >-
              Filter by refund analysis result: TOTALLY_ACCEPTED,
              PARTIALLY_ACCEPTED, REJECTED
            type: string
        - description: Filter by refund transaction ID (32 characters)
          explode: false
          in: query
          name: refund_transaction_id
          schema:
            description: Filter by refund transaction ID (32 characters)
            type: string
        - description: >-
            Filter by refunds modified after this timestamp (RFC3339 format:
            2024-01-15T10:30:00Z)
          explode: false
          in: query
          name: modified_after
          schema:
            description: >-
              Filter by refunds modified after this timestamp (RFC3339 format:
              2024-01-15T10:30:00Z)
            type: string
        - description: >-
            Filter by refunds modified before this timestamp (RFC3339 format:
            2024-01-15T10:30:00Z)
          explode: false
          in: query
          name: modified_before
          schema:
            description: >-
              Filter by refunds modified before this timestamp (RFC3339 format:
              2024-01-15T10:30:00Z)
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllRefundsOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    GetAllRefundsOutput:
      additionalProperties: false
      properties:
        items:
          description: Refund requests on the current page
          items:
            $ref: '#/components/schemas/RefundOutput'
          type: array
        limit:
          description: Number of items per page
          examples:
            - 10
          format: int64
          type: integer
        page:
          description: Current page number
          examples:
            - 1
          format: int64
          type: integer
        total:
          description: Total number of refund requests matching the filters
          examples:
            - 85
          format: int64
          type: integer
      required:
        - items
        - page
        - limit
        - total
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        code:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    RefundOutput:
      additionalProperties: false
      properties:
        accountId:
          description: Account ID (UUID)
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        analysisDetails:
          description: Analysis comments (max 2000 characters)
          examples:
            - Analysis confirms fraud. Refund approved.
          type: string
        analysisResult:
          description: Analysis result (if closed)
          enum:
            - TOTALLY_ACCEPTED
            - PARTIALLY_ACCEPTED
            - REJECTED
          examples:
            - TOTALLY_ACCEPTED
          type: string
        bacenFundsRecoveryId:
          description: >-
            BACEN/BTG funds-recovery identifier resolved via the associated
            infraction report (read-only, JOIN-derived)
          examples:
            - 91d65e98-97c0-4b0f-b577-73625da1f9fc
          type: string
        bacenRefundRequestId:
          description: BACEN/BTG refund request external identifier
          examples:
            - 3d48532f-a1b2-4422-81c3-b7dc852e262b
          type: string
        contestedParticipant:
          description: >-
            ISPB of the contested participant (8 uppercase alphanumeric
            characters)
          examples:
            - '12345678'
          type: string
        createdAt:
          description: Creation timestamp (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        effectiveRefundedAmount:
          description: Amount effectively refunded in BRL
          examples:
            - '100.00'
          type: string
        id:
          description: Unique identifier of the refund request (UUID)
          examples:
            - 550e8400-e29b-41d4-a716-44665544r001
          type: string
        infractionReportId:
          description: Related infraction report ID (UUID)
          examples:
            - 550e8400-e29b-41d4-a716-44665544f001
          type: string
        monitorAccount:
          description: BACEN flag for account monitoring
          examples:
            - true
          type: boolean
        refundAccount:
          $ref: '#/components/schemas/RefundAccountOutput'
          description: Refund destination account details
        refundAmount:
          description: 'Refund amount in BRL (format: 0.00)'
          examples:
            - '100.50'
          type: string
        refundDetails:
          description: Detailed justification (max 2000 characters)
          examples:
            - Customer reports unauthorized transaction
          type: string
        refundReason:
          description: Reason for the refund
          enum:
            - FRAUD
            - OPERATIONAL_FLAW
            - REFUND_CANCELLED
          examples:
            - FRAUD
          type: string
        refundRejectionReason:
          description: Rejection reason (if rejected)
          enum:
            - NO_BALANCE
            - ACCOUNT_CLOSURE
            - INVALID_REQUEST
            - OTHER
          examples:
            - NO_BALANCE
          type: string
        refundTransactionId:
          description: Refund transaction ID (if accepted, 32 characters)
          examples:
            - E98765432202411241500REFUNDTRANS
          type: string
        requestingParticipant:
          description: >-
            ISPB of the requesting participant (8 uppercase alphanumeric
            characters)
          examples:
            - '30306294'
          type: string
        status:
          description: Current status of the refund request
          enum:
            - OPEN
            - CLOSED
            - CANCELLED
          examples:
            - OPEN
          type: string
        transactionId:
          description: Pix End-to-End transaction ID (32 characters)
          examples:
            - E12345678202411241430ABCDEFGHIJK
          type: string
        updatedAt:
          description: Last update timestamp (ISO 8601 UTC)
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
      required:
        - id
        - bacenRefundRequestId
        - accountId
        - transactionId
        - requestingParticipant
        - contestedParticipant
        - refundReason
        - refundAmount
        - status
        - createdAt
        - updatedAt
      type: object
    RefundAccountOutput:
      additionalProperties: false
      properties:
        accountNumber:
          description: Account number
          examples:
            - '123456'
          type: string
        accountType:
          description: Account type (CACC, SVGS, TRAN)
          examples:
            - CACC
          type: string
        branch:
          description: Branch number
          examples:
            - '0001'
          type: string
        document:
          description: CPF or CNPJ of the account holder
          examples:
            - '12345678909'
          type: string
        participant:
          description: ISPB code of the participant institution
          examples:
            - '99999011'
          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.