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

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



## OpenAPI

````yaml /api/openapi.json get /v2/payments
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/payments:
    get:
      tags:
        - Payments
      summary: List payments
      description: >-
        Retrieve a paginated list of all payment transactions for the
        authenticated user with filtering and sorting options.
      parameters:
        - name: filter[search]
          in: query
          description: Search payments by id, note, or serviceable_id
          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[type]
          in: query
          description: >-
            Filter by exact type. Supports comma-separated values for multiple
            matches.
          required: false
          schema:
            type: string
            example: example
        - name: filter[serviceable_type]
          in: query
          description: >-
            Filter by exact serviceable type. Supports comma-separated values
            for multiple matches.
          required: false
          schema:
            type: string
            example: example
        - name: filter[serviceable_id]
          in: query
          description: >-
            Filter by exact serviceable id. Supports comma-separated values for
            multiple matches.
          required: false
          schema:
            type: string
            example: 313493
        - name: filter[is_fine]
          in: query
          description: Filter by fine 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: sort
          in: query
          description: Sort by field. Prefix with - for descending order.
          required: false
          schema:
            enum:
              - id
              - '-id'
              - type
              - '-type'
              - amount
              - '-amount'
              - balance_after
              - '-balance_after'
              - is_fine
              - '-is_fine'
              - created_at
              - '-created_at'
              - updated_at
              - '-updated_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 user payments
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserPayment'
                  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:
    UserPayment:
      description: User payment transaction record representing balance changes
      type: object
      properties:
        id:
          description: Unique identifier for the payment transaction
          type: integer
        type:
          description: >-
            Type of payment transaction (e.g., account_sale, withdrawal, bonus,
            fine)
          enum:
            - bonus
            - tip
            - other
            - compensation
            - withdrawal
            - withdrawal_cancellation
            - boost_completion
            - lesson_completion
            - service_order_completion
            - account_sale
            - skin_sale
            - item_sale
            - currency_sale
            - game_key_sale
            - warehouse_sale
            - boost_completion_cancellation
            - lesson_completion_cancellation
            - skin_sale_cancellation
            - service_order_cancellation
            - account_sale_cancellation
            - item_sale_cancellation
            - warehouse_sale_cancellation
            - currency_sale_cancellation
            - game_key_sale_cancellation
            - referral_reward
            - boost_loss_demotion_fine
            - order_cancellation_fine
            - toxic_behavior_fine
            - chat_ban_fine
            - account_ban_fine
            - general_fine
            - partner_penalty
            - partner_penalty_refund
          type: string
        note:
          description: Optional note or description explaining the payment
          type: string
          nullable: true
        order_type:
          description: Type of related order if applicable (e.g., AccountOrder, ItemOrder)
          type: string
          nullable: true
        order_id:
          description: ID of the related order if applicable
          type: integer
          nullable: true
        amount_eur:
          description: >-
            Payment amount in EUR currency (positive for credit, negative for
            debit)
          type: string
        amount_usd:
          description: Payment amount converted to USD
          type: string
        balance_after_eur:
          description: User balance after this transaction in EUR
          type: string
        balance_after_usd:
          description: User balance after this transaction in USD
          type: string
        is_fine:
          description: Indicates if this payment is a penalty or fine
          type: boolean
        is_warehouse:
          description: >-
            Indicates if this payment affects warehouse balance instead of main
            balance
          type: boolean
        created_at:
          description: Unix timestamp when the payment was created
          type: integer
        updated_at:
          description: Unix timestamp of the last modification to the payment
          type: integer
  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

````