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

# List All Payout Summary

> Fetches payout summary reports between the provided fromDate and toDate with pagination support.

# Retrieve Payout Summary by Date Range

This endpoint fetches payout summary records within a given date range, with pagination support.

## Path Parameters

* **fromDate** (string, required):\
  The starting date (inclusive) for the date range filter.\
  Format: `yyyy-MM-dd HH:mm:ss`
  * Example: `2025-01-01 00:00:00`
  * The API will retrieve all payout summary records created **on or after this date**.

* **toDate** (string, required):\
  The ending date (inclusive) for the date range filter.\
  Format: `yyyy-MM-dd HH:mm:ss`
  * Example: `2025-01-31 23:59:59`
  * The API will retrieve all payout summary records created **on or before this date**.

📌 **How it Works**\
If you specify a **fromDate** of `2025-01-01 00:00:00` and a **toDate** of `2025-01-31 23:59:59`, the API will return all payout summary records that were created within this date range. The results will be paginated based on the provided query parameters.

## Query Parameters

* **page** (integer, optional, default: 0): The page number to fetch.
* **size** (integer, optional, default: 10): The number of records per page.

## Request Headers

* **User-Agent** (string, optional): The User-Agent header, which is not mandatory.

## Example Request

```http theme={null}
GET /get-payout-summary/2025-01-01%2000:00:00/2025-01-31%2023:59:59?page=1&size=20
User-Agent: Mozilla/5.0
```


## OpenAPI

````yaml GET /get-payout-summary/{fromDate}/{toDate}
openapi: 3.0.1
info:
  title: OP APIs
  description: OP APIs
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://sandbox.omnispay.com/api/
    description: Sandbox server for testing and integration without affecting live data
security:
  - apiKey: []
    hmacSignature: []
    accountId: []
paths:
  /get-payout-summary/{fromDate}/{toDate}:
    get:
      tags:
        - Public API for Payment Link Operations
      summary: Retrieve payout summary reports within the given date range
      description: >-
        Fetches payout summary reports between the provided fromDate and toDate
        with pagination support.
      operationId: getUserPayoutSummeryReportsInDateRange
      parameters:
        - name: User-Agent
          in: header
          required: false
          schema:
            type: string
        - name: fromDate
          in: path
          description: Start date in format yyyy-MM-dd HH:mm:ss
          required: true
          schema:
            type: string
            format: date-time
          example: '2025-01-01 00:00:00'
        - name: toDate
          in: path
          description: End date in format yyyy-MM-dd HH:mm:ss
          required: true
          schema:
            type: string
            format: date-time
          example: '2025-01-31 23:59:59'
        - name: page
          in: query
          description: 'Page number for pagination (default: 0)'
          required: false
          schema:
            type: integer
            format: int32
            default: 0
        - name: size
          in: query
          description: 'Number of records per page (default: 10)'
          required: false
          schema:
            type: integer
            format: int32
            default: 10
      responses:
        '200':
          description: OK. Payout summary records retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '400':
          description: Bad Request. Invalid or malformed date range
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '401':
          description: Unauthorized. Access denied due to invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '403':
          description: Forbidden. You do not have permission to access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '404':
          description: Not Found. No payout summary records exist for the given date range
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '409':
          description: >-
            Conflict. A conflict occurred while retrieving the payout summary
            records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '429':
          description: >-
            Too Many Requests. The user has exceeded the allowed number of
            requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '500':
          description: >-
            Internal Server Error. An unexpected error occurred while processing
            the request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
components:
  schemas:
    CommonResponse:
      type: object
      properties:
        status:
          type: string
        message:
          type: string
        response:
          type: object
  securitySchemes:
    apiKey:
      type: apiKey
      name: apiKey
      in: header
    hmacSignature:
      type: apiKey
      name: X-HMAC-Signature
      in: header
    accountId:
      type: apiKey
      name: accountId
      in: header

````