> ## 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.

# Retrieve Payout Summary

> This API fetches the payout summary report associated with the given order ID.

# Retrieve Payout Summary by Order Id.

This endpoint retrieves **payout summary** from the database based on the provided order ID.

## Path Parameters

* **id** (string, required):\
  The unique identifier of the payout summary record to be retrieved.
  * Example: `123457`
  * If a valid ID is provided, the API will return the payout summary.

📌 **How it Works**\
The system fetches payout summary for the given ID and returns payout summary.

## Request Headers

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

## Example Request

```http theme={null}
GET /get-payout-summary/123457
User-Agent: Mozilla/5.0
```


## OpenAPI

````yaml GET /get-payout-summary/{id}
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/{id}:
    get:
      tags:
        - Public API for Payment Link Operations
      summary: Retrieve payout summary by order ID
      description: >-
        This API fetches the payout summary report associated with the given
        order ID.
      operationId: getUserPayoutSummaryReportsByOrderId
      parameters:
        - name: User-Agent
          in: header
          required: false
          schema:
            type: string
        - name: id
          in: path
          description: Order ID for retrieving the payout summary report
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK. Payout summary retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '400':
          description: Bad Request. Invalid or malformed order ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '401':
          description: >-
            Unauthorized. Access denied due to invalid credentials or missing
            authentication token
          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 exists for the specified order ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '409':
          description: Conflict. A conflict occurred while retrieving the payout summary
          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

````