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

# List Payouts

> Retrieve a list of payouts created within a specific time range, with support for filtering and pagination. This endpoint allows you to track and analyse all payout transactions to your account. It's useful for building dashboards, reconciling payouts, or reviewing recent payout transactions programmatically.



## OpenAPI

````yaml GET /balance/payouts
openapi: 3.0.1
info:
  title: xPay API Store
  description: ''
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.xpaycheckout.com
security:
  - basicAuth: []
paths:
  /balance/payouts:
    get:
      description: >-
        Retrieve a list of payouts created within a specific time range, with
        support for filtering and pagination. This endpoint allows you to track
        and analyse all payout transactions to your account. It's useful for
        building dashboards, reconciling payouts, or reviewing recent payout
        transactions programmatically.
      parameters:
        - $ref: '#/components/parameters/StartTime'
        - $ref: '#/components/parameters/EndTime'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 100
          description: Max items per page (default 10, max 100)
          example: 50
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Successful response with payouts and pagination cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-payouts-response'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    StartTime:
      name: startTime
      in: query
      required: false
      schema:
        type: integer
        format: int64
      description: >-
        Start of range in epoch milliseconds. Fetches items created after this
        timestamp.
    EndTime:
      name: endTime
      in: query
      required: false
      schema:
        type: integer
        format: int64
      description: >-
        End of range in epoch milliseconds. Fetches items created before this
        timestamp.
    Offset:
      name: offset
      in: query
      required: false
      schema:
        type: string
      description: >-
        Cursor-based pagination token. Use the `offset` value from
        `metadata.offset` in the previous response to fetch the next page.
        Continue until `metadata.offset` is no longer present in the response.


        🚨 **Important**: Changing any query parameters invalidates existing
        offset values and requires restarting pagination from the beginning.


        For detailed pagination implementation guide, see [Pagination
        Guide](/developer-resources/pagination).
  schemas:
    get-payouts-response:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Payout'
        metadata:
          type: object
          properties:
            offset:
              $ref: '#/components/schemas/PaginationOffset'
      required:
        - data
        - metadata
    Error:
      required:
        - errorCode
        - errorDescription
      type: object
      properties:
        errorCode:
          type: string
          example: bad_request
        errorDescription:
          type: string
          example: Failed to read request
    Payout:
      type: object
      properties:
        payoutId:
          type: string
          description: Unique identifier of the payout
        amount:
          $ref: '#/components/schemas/PayoutAmount'
        status:
          $ref: '#/components/schemas/PayoutStatus'
        createdAt:
          $ref: '#/components/schemas/PayoutCreatedAt'
      required:
        - payoutId
        - amount
        - status
        - createdAt
    PaginationOffset:
      type: string
      description: >-
        Pagination cursor for fetching the next page of results. Use this exact
        string as the `offset` parameter in your next API request. When this
        field is missing or null, you've reached the end of the results.


        For detailed pagination implementation guide, see [Pagination
        Guide](/developer-resources/pagination).
    PayoutAmount:
      type: integer
      format: int64
      description: Amount in cents (USD)
      example: 30000
    PayoutStatus:
      type: string
      description: Current status of the payout
      enum:
        - INITIATED
        - SUCCESS
        - FAILED
      example: SUCCESS
    PayoutCreatedAt:
      type: integer
      description: Epoch timestamp in milliseconds of when the payout was created
      example: 1727340330123
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````