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

# List Refunds

> Retrieve a list of refunds with optional filtering.



## OpenAPI

````yaml GET /pg/refunds/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API
  description: >-
    API for payment processing and order management through Eximpe payment
    gateway. This specification includes v1, v2, and v3 API versions.
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api-pacb-uat.eximpe.com
    description: Payment Gateway Sandbox URL
security:
  - clientAuth: []
    clientSecretAuth: []
    apiVersionHeader: []
tags:
  - name: Card Tokens
  - name: Merchants
  - name: Orders
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Settlements
  - name: Subscriptions
paths:
  /pg/refunds/:
    get:
      tags:
        - Refunds
      summary: List Refunds
      description: Retrieve a list of refunds with optional filtering.
      operationId: v1_get_pg_refunds_
      parameters:
        - name: payment_id
          in: query
          description: Filter by payment ID.
          schema:
            type: string
        - name: reference_id
          in: query
          description: Filter by order reference ID.
          schema:
            type: string
        - name: from_date
          in: query
          description: 'Filter refunds created from this date. Format: YYYY-MM-DD.'
          schema:
            type: string
            format: date
        - name: to_date
          in: query
          description: 'Filter refunds created up to this date. Format: YYYY-MM-DD.'
          schema:
            type: string
            format: date
        - name: merchant_id
          in: query
          description: Filter refunds by merchant ID.
          schema:
            type: string
      responses:
        '200':
          description: A paginated list of refunds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_ListRefundsResponse'
              example:
                count: 4
                page: 1
                page_size: 250
                next: null
                previous: null
                results:
                  - refund_id: RF8380989720
                    refund_amount: 11
                    refund_status: INITIATED
                    refunded_at: null
                    message: Refund Request Queued
                    payment_id: PR8867819681
                  - refund_id: RF8370660295
                    refund_amount: 12
                    refund_status: INITIATED
                    refunded_at: null
                    message: No action status found
                    payment_id: PR3828502708
      security:
        - clientAuth: []
          clientSecretAuth: []
          apiVersionHeader: []
components:
  schemas:
    v1_ListRefundsResponse:
      type: object
      required:
        - count
        - page
        - page_size
        - next
        - previous
        - results
      properties:
        count:
          type: integer
          description: Total number of refunds
        page:
          type: integer
          description: Current page number
        page_size:
          type: integer
          description: Number of refunds per page
        next:
          type: string
          nullable: true
          description: URL for the next page of results
        previous:
          type: string
          nullable: true
          description: URL for the previous page of results
        results:
          type: array
          items:
            $ref: '#/components/schemas/v1_RefundInList'
    v1_RefundInList:
      type: object
      required:
        - refund_id
        - refund_amount
        - refund_status
        - refunded_at
        - message
        - payment_id
      properties:
        refund_id:
          type: string
          description: Unique identifier for the refund.
        refund_amount:
          type: number
          format: float
          description: The refunded amount.
        refund_status:
          type: string
          description: The status of the refund.
        refunded_at:
          type: string
          format: date-time
          nullable: true
          description: The timestamp of when the refund was completed.
        message:
          type: string
          nullable: true
          description: A message providing more detail about the refund status.
        payment_id:
          type: string
          description: The ID of the payment that was refunded.
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: >-
        **Client Application ID** - Your unique application identifier used to
        authenticate API requests. You can find your Client ID in the Developer
        Settings section of the merchant dashboard.
      x-displayName: Client ID
      x-example: your-client-id
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: >-
        **Client Secret Key** - Your secret key used alongside the Client ID for
        secure authentication. Keep this confidential and never expose it in
        client-side code. Available in the Developer Settings section of the
        merchant dashboard.
      x-displayName: Client Secret
      x-example: your-client-secret
    apiVersionHeader:
      type: apiKey
      name: X-API-Version
      in: header
      description: >-
        **API Version** - Specifies which version of the API to use (e.g.,
        '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which
        API version your integration uses. Default version information is
        available in the Developer Settings.
      x-displayName: API Version
      x-example: 3.0.0

````