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

# Get a payout request

> Retrieve detailed information about a specific payout request including method, status, and amounts.



## OpenAPI

````yaml /api/openapi.json get /v2/payouts/{payoutRequest}
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/{payoutRequest}:
    get:
      tags:
        - Payouts
      summary: Get a payout request
      description: >-
        Retrieve detailed information about a specific payout request including
        method, status, and amounts.
      parameters:
        - name: payoutRequest
          in: path
          description: >-
            The ID of the payout request. Can be retrieved from the list of
            payout requests.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A single payout request
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PayoutRequest'
        '401':
          $ref: '#/components/responses/ErrorUnauthenticated'
        '403':
          $ref: '#/components/responses/ErrorForbidden'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '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.
    ErrorForbidden:
      description: >-
        User is not authorized to perform this action, happens when you try to
        access a resource you do not have permission to access
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: This action is unauthorized.
    ErrorNotFound:
      description: Resource not found, happens when the requested resource does not exist
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Resource not found.
    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

````