> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fincle.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# List refund requests

> Lists the refund requests submitted by payers.



## OpenAPI

````yaml /openapi.yaml get /refund-requests
openapi: 3.0.3
info:
  title: Fincle API
  version: 1.0.0
  description: >-
    Fincle payments API: charges by Pix, credit card and boleto, subscriptions,
    transactions, refunds, infractions, notifications and transfers.
servers:
  - url: https://api.fincle.com.br
    description: Production server
security: []
tags:
  - name: Authentication
    description: Issuance of the access token from the API key.
  - name: Charges
    description: Creation of charges by Pix, credit card and boleto.
  - name: Subscriptions
    description: Recurring billing on credit card.
  - name: Transactions
    description: Retrieval and refund of transactions.
  - name: Refunds
    description: Refund requests submitted by payers.
  - name: Infractions and MED
    description: Pix infraction reports and the amounts blocked as a result.
  - name: Webhooks
    description: Registration of notification endpoints and tracking of deliveries.
  - name: Balance and transfers
    description: Balance, statement, fees and transfer of the amounts received.
paths:
  /refund-requests:
    get:
      tags:
        - Refunds
      summary: List refund requests
      description: Lists the refund requests submitted by payers.
      operationId: listRefundRequests
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          in: query
          name: page
          required: false
          description: Requested page, starting at 1.
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          in: query
          name: pageSize
          required: false
          description: Number of items per page (maximum 100).
        - schema:
            type: string
            enum:
              - pending
              - approved
              - rejected
              - processed
              - canceled
          in: query
          name: status
          required: false
          description: Filters by refund request status.
        - schema:
            type: string
            enum:
              - api
              - manual_pending
              - manual_done
          in: query
          name: refundChannel
          required: false
          description: Filters by the channel that executed the refund.
        - schema:
            type: string
            format: date-time
          in: query
          name: startDate
          required: false
          description: Considers only requests opened on or after this date.
        - schema:
            type: string
            format: date-time
          in: query
          name: endDate
          required: false
          description: Considers only requests opened on or before this date.
        - schema:
            type: string
            minLength: 1
          in: query
          name: search
          required: false
          description: >-
            Searches by the payer's name or email address, or by the name of a
            product in the transaction.
      responses:
        '200':
          description: Page of refund requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `true` in a successful response.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Refund request identifier.
                        transactionId:
                          type: string
                          description: >-
                            Identifier of the transaction the payer wants
                            refunded.
                        status:
                          type: string
                          enum:
                            - pending
                            - approved
                            - rejected
                            - processed
                            - canceled
                          description: Status of the request in the integrator's queue.
                        reason:
                          type: string
                          nullable: true
                          description: Reason stated by the payer.
                        reasonType:
                          type: string
                          nullable: true
                          description: >-
                            Category of the reason, when the source classified
                            it.
                        requestedBy:
                          type: string
                          nullable: true
                          description: >-
                            Who opened the request: the payer, support or the
                            system.
                        rejectionReason:
                          type: string
                          nullable: true
                          description: >-
                            Justification given by the integrator when
                            rejecting.
                        approvalReason:
                          type: string
                          nullable: true
                          description: Reason given by the integrator when approving.
                        reviewedAt:
                          type: string
                          format: date-time
                          nullable: true
                          description: Time at which the integrator decided.
                        autoApproveAt:
                          type: string
                          format: date-time
                          nullable: true
                          description: >-
                            When the platform approves the request automatically
                            on expiry of the deadline; `null` when no deadline
                            is running.
                        amount:
                          type: integer
                          description: Transaction amount in cents (R$ 199.00 = 19900).
                        paymentMethod:
                          type: string
                          enum:
                            - pix
                            - credit_card
                            - boleto
                            - multiple_cards
                          description: Payment method of the transaction to be refunded.
                        refundChannel:
                          type: string
                          enum:
                            - api
                            - manual_pending
                            - manual_done
                          nullable: true
                          description: >-
                            Channel that executed the refund: `api`,
                            `manual_pending` or `manual_done`.
                        customer:
                          type: object
                          properties:
                            name:
                              type: string
                              nullable: true
                              description: Name of the payer who requested the refund.
                            email:
                              type: string
                              nullable: true
                              description: Payer's email address.
                            document:
                              type: string
                              nullable: true
                              description: Payer's CPF or CNPJ, digits only.
                            phone:
                              type: string
                              nullable: true
                              description: Payer's phone number.
                          required:
                            - name
                            - email
                            - document
                            - phone
                          additionalProperties: false
                          nullable: true
                          description: Payer of the transaction.
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                description: Transaction item identifier.
                              name:
                                type: string
                                description: Product name at the time of purchase.
                              quantity:
                                type: integer
                                description: Quantity purchased.
                              unitPrice:
                                type: integer
                                description: Unit price in cents (R$ 49.90 = 4990).
                            required:
                              - id
                              - name
                              - quantity
                              - unitPrice
                            additionalProperties: false
                          description: Items of the transaction.
                        createdAt:
                          type: string
                          format: date-time
                          description: Time at which the request was opened.
                        updatedAt:
                          type: string
                          format: date-time
                          description: Time of the last change to the request.
                      required:
                        - id
                        - transactionId
                        - status
                        - reason
                        - reasonType
                        - requestedBy
                        - rejectionReason
                        - approvalReason
                        - reviewedAt
                        - autoApproveAt
                        - amount
                        - paymentMethod
                        - refundChannel
                        - customer
                        - items
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        description: Page returned.
                      pageSize:
                        type: integer
                        description: Items per page requested.
                      total:
                        type: integer
                        description: Total number of items matching the filter.
                      totalPages:
                        type: integer
                        description: Total number of pages available.
                    required:
                      - page
                      - pageSize
                      - total
                      - totalPages
                    additionalProperties: false
                required:
                  - success
                  - data
                  - pagination
                additionalProperties: false
                description: Page of refund requests.
              example:
                success: true
                data:
                  - id: 48127
                    transactionId: clx9b3k2p0007qz0a7h8i9j0k
                    status: pending
                    reason: Product not in conformity with the offer.
                    reasonType: quiz
                    requestedBy: customer
                    rejectionReason: null
                    approvalReason: null
                    reviewedAt: null
                    autoApproveAt: '2026-09-14T10:32:00.000Z'
                    amount: 19700
                    paymentMethod: pix
                    refundChannel: null
                    customer:
                      name: Helena Martins Andrade
                      email: helena.andrade@example.com
                      document: '31845792041'
                      phone: '+5511932104567'
                    items:
                      - id: 90321
                        name: Annual software license
                        quantity: 1
                        unitPrice: 14900
                      - id: 90322
                        name: Implementation service
                        quantity: 1
                        unitPrice: 4800
                    createdAt: '2026-09-12T10:32:00.000Z'
                    updatedAt: '2026-09-12T10:32:00.000Z'
                pagination:
                  page: 1
                  pageSize: 10
                  total: 1
                  totalPages: 1
        '401':
          description: Token missing, invalid, expired or belonging to a blocked account.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Token missing, invalid, expired or belonging to a blocked
                  account.
              example:
                success: false
                message: Token inválido ou expirado
        '422':
          description: The request did not pass schema validation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: The request did not pass schema validation.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Too many requests: the limit is 1000 requests per minute per source
            IP. Wait the number of seconds given in the `retry-after` header and
            retry with exponential backoff.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Too many requests: the limit is 1000 requests per minute per
                  source IP. Wait the number of seconds given in the
                  `retry-after` header and retry with exponential backoff.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Internal failure while processing the request. Retry; if it
            persists, open a support ticket stating the time and the route.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Internal failure while processing the request. Retry; if it
                  persists, open a support ticket stating the time and the
                  route.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Seconds to wait before repeating the request.
      schema:
        type: integer
    x-ratelimit-limit:
      description: >-
        Maximum number of requests in the window (1000). Present in every
        response.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Number of requests still available in the current window. Present in
        every response.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Seconds until the window counter resets. Present in every response.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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