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

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# List Refunds

> Retrieves a filtered, paginated list of processed refund logs for the active brand.




## OpenAPI

````yaml /api/merchant_api.yaml get /refunds
openapi: 3.1.0
info:
  title: OwnPay Merchant API
  description: >
    The OwnPay Merchant API enables merchants to programmatically interface with
    their white-labeled payment gateway.

    It exposes endpoints to initiate payments (creating payment intents), query
    transaction statuses, issue full or partial refunds, manage customer
    profiles securely in compliance with GDPR and OWASP, generate and revoke API
    keys, and test/audit webhook delivery attempts.


    ### Authentication

    Authentication is performed via HTTP Bearer token in the `Authorization`
    header.

    ```http

    Authorization: Bearer your_api_key_here

    ```

    API keys carry specific privilege scopes (e.g., `read`, `write`, `admin`).

    Some administrative operations (like listing/generating API keys) require
    **both** `write` and `admin` scopes, as well as passing a valid platform
    super-administrator's email address in the `X-Super-Admin-Email` header for
    safety.
  version: 1.0.0
servers:
  - url: https://{brand_domain}/api/v1
    description: Sandbox or Production white-labeled brand gateway API server.
    variables:
      brand_domain:
        default: ownpay.org
        description: The custom domain configured for your white-labeled brand.
security:
  - BearerAuth: []
paths:
  /refunds:
    get:
      summary: List Refunds
      description: >
        Retrieves a filtered, paginated list of processed refund logs for the
        active brand.
      operationId: listRefunds
      parameters:
        - name: page
          in: query
          description: Page number to retrieve.
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          description: Maximum records per page.
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: status
          in: query
          description: Filter by refund status (e.g. `completed`, `pending`, `failed`).
          required: false
          schema:
            type: string
        - name: trx_id
          in: query
          description: Filter by original transaction reference code.
          required: false
          schema:
            type: string
        - name: transaction_id
          in: query
          description: Filter by internal transaction integer ID.
          required: false
          schema:
            type: integer
        - name: from
          in: query
          description: Start boundary (YYYY-MM-DD) for creation date.
          required: false
          schema:
            type: string
            format: date
        - name: to
          in: query
          description: End boundary (YYYY-MM-DD) for creation date.
          required: false
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Paginated refunds list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRefundsResponse'
components:
  schemas:
    PaginatedRefundsResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items: 6503763d-fd27-4b9f-a0b4-e16c6a4ac51b
        meta:
          type: object
          properties:
            page:
              type: integer
              example: 1
            per_page:
              type: integer
              example: 25
            total:
              type: integer
              example: 3
            total_pages:
              type: integer
              example: 1
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Provide the Bearer API Key generated for your brand.

````

## Related topics

- [Retrieve Refund](/docs/api-reference/retrieve-refund.md)
- [Node.js SDK - TypeScript-First Payment Integration](/docs/developer/integration/nodejs.md)
- [Request Transaction Refund](/docs/api-reference/request-transaction-refund.md)
- [List Customers](/docs/api-reference/list-customers.md)
- [List Transactions](/docs/api-reference/list-transactions.md)