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

# List payout requests

> Retrieve a paginated list of all payout requests for the authenticated user with filtering and sorting options.



## OpenAPI

````yaml /api/openapi.json get /v2/payouts
openapi: 3.1.0
info:
  title: GameBoost
  version: 2.0.0
servers:
  - url: https://api.gameboost.com
    description: GameBoost API
security:
  - BearerTokenSecurityScheme: []
tags:
  - name: Games
    description: Games
  - name: Seller Breaks
    description: Seller Breaks
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: Account Offers
    description: Account Offers
  - name: Account Orders
    description: Account Orders
  - name: Item Offers
    description: Item Offers
  - name: Item Orders
    description: Item Orders
  - name: Currency Offers
    description: Currency Offers
  - name: Currency Orders
    description: Currency Orders
  - name: Webhooks
    description: Webhook events sent to your endpoints when specific actions occur
  - name: Gift Card Offers
    description: Gift Card Offers
  - name: Gift Card Orders
    description: Gift Card Orders
paths:
  /v2/payouts:
    get:
      tags:
        - Payouts
      summary: List payout requests
      description: >-
        Retrieve a paginated list of all payout requests for the authenticated
        user with filtering and sorting options.
      parameters:
        - name: filter[search]
          in: query
          description: Search payout requests by id or note
          required: false
          schema:
            type: string
        - name: filter[id]
          in: query
          description: >-
            Filter by exact id. Supports comma-separated values for multiple
            matches.
          required: false
          schema:
            type: string
            example: 3,6,9
        - name: filter[method]
          in: query
          description: >-
            Filter by exact method. Supports comma-separated values for multiple
            matches.
          required: false
          schema:
            type: string
            example: example
        - name: filter[status]
          in: query
          description: >-
            Filter by exact status. Supports comma-separated values for multiple
            matches.
          required: false
          schema:
            type: string
            example: example
        - name: filter[is_custom]
          in: query
          description: Filter by custom status
          required: false
          schema:
            type: boolean
        - name: filter[is_warehouse]
          in: query
          description: Filter by warehouse status
          required: false
          schema:
            type: boolean
        - name: filter[created_at]
          in: query
          description: >-
            Filter by created at. Supports single date (YYYY-MM-DD) or date
            range (YYYY-MM-DD,YYYY-MM-DD).
          required: false
          schema:
            type: string
            example: 2019-08-14,2025-12-31
        - name: filter[updated_at]
          in: query
          description: >-
            Filter by updated at. Supports single date (YYYY-MM-DD) or date
            range (YYYY-MM-DD,YYYY-MM-DD).
          required: false
          schema:
            type: string
            example: '2025-10-05'
        - name: filter[paid_at]
          in: query
          description: >-
            Filter by paid at. Supports single date (YYYY-MM-DD) or date range
            (YYYY-MM-DD,YYYY-MM-DD).
          required: false
          schema:
            type: string
            example: 2019-08-14,2025-12-31
        - name: filter[rejected_at]
          in: query
          description: >-
            Filter by rejected at. Supports single date (YYYY-MM-DD) or date
            range (YYYY-MM-DD,YYYY-MM-DD).
          required: false
          schema:
            type: string
            example: 2019-08-14,2025-12-31
        - name: filter[completed_at]
          in: query
          description: >-
            Filter by completed at. Supports single date (YYYY-MM-DD) or date
            range (YYYY-MM-DD,YYYY-MM-DD).
          required: false
          schema:
            type: string
            example: 2019-08-14,2025-12-31
        - name: sort
          in: query
          description: Sort by field. Prefix with - for descending order.
          required: false
          schema:
            enum:
              - id
              - '-id'
              - method
              - '-method'
              - status
              - '-status'
              - requested_amount
              - '-requested_amount'
              - partner_amount
              - '-partner_amount'
              - paid_amount
              - '-paid_amount'
              - created_at
              - '-created_at'
              - updated_at
              - '-updated_at'
              - paid_at
              - '-paid_at'
              - completed_at
              - '-completed_at'
            default: '-created_at'
            type: string
            example: '-created_at'
        - name: per_page
          in: query
          description: Items per page (max 50)
          required: false
          schema:
            default: 15
            type: integer
            maximum: 50
            minimum: 1
      responses:
        '200':
          description: A paginated list of payout requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PayoutRequest'
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      from:
                        type: integer
                      last_page:
                        type: integer
                      per_page:
                        type: integer
                      to:
                        type: integer
                      total:
                        type: integer
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        nullable: true
                      last:
                        type: string
                        nullable: true
                      prev:
                        type: string
                        nullable: true
                      next:
                        type: string
                        nullable: true
        '401':
          $ref: '#/components/responses/ErrorUnauthenticated'
        '429':
          $ref: '#/components/responses/ErrorRateLimited'
      security:
        - BearerToken: []
components:
  schemas:
    PayoutRequest:
      description: Payout request object representing a partner withdrawal request
      type: object
      properties:
        id:
          description: Unique identifier for the payout request
          type: integer
        method:
          description: >-
            Payment method for the payout (e.g., PayPal, bank transfer,
            cryptocurrency)
          type: string
        note:
          description: Optional note or description about the payout request
          type: string
          nullable: true
        status:
          description: >-
            Current status of the payout request (requested, processing,
            completed, rejected, canceled)
          enum:
            - requested
            - rejected
            - processing
            - completed
            - canceled
          type: string
        requested_amount_eur:
          description: Amount requested for payout in EUR currency
          type: string
        requested_amount_usd:
          description: Amount requested for payout converted to USD
          type: string
        received_amount_eur:
          description: Final amount received after fees and processing in EUR
          type: string
        received_amount_usd:
          description: Final amount received after fees and processing in USD
          type: string
        is_warehouse:
          description: >-
            Indicates if this payout is from warehouse balance instead of main
            balance
          type: boolean
        created_at:
          description: Unix timestamp when the payout request was created
          type: integer
        updated_at:
          description: Unix timestamp of the last modification to the payout request
          type: integer
        paid_at:
          description: Unix timestamp when the payout was processed and paid
          type: integer
          nullable: true
        rejected_at:
          description: Unix timestamp when the payout request was rejected
          type: integer
          nullable: true
        completed_at:
          description: Unix timestamp when the payout was successfully completed
          type: integer
          nullable: true
  responses:
    ErrorUnauthenticated:
      description: >-
        User is not authenticated, happens when the API key is missing, expired
        or invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthenticated.
    ErrorRateLimited:
      description: >-
        Rate limit exceeded, happens when you exceed the rate limit for the
        endpoint
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Too many requests.
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````