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

# Get Bags Payout Token Events

> The payment events of one token, for example to draw markers on its price chart. An event is one completed end-to-end send: a Peer fill the buyer paid and that was released with verified cash. Only X Money payments are returned unless `method` says otherwise.

**Offset Mode** (default): use `mode=offset` (or omit `mode`) with `limit` and `offset`. Events are ordered newest first.

**Time Mode**: use `mode=time` with `from` and `to` unix timestamps (both inclusive and required). Events are ordered oldest first (chart order), up to 1000 events; `hasMore` is `true` when the range holds more.

Sending offset parameters in time mode, or time parameters in offset mode, is rejected with 400.



## OpenAPI

````yaml GET /bags-payout/token/events
openapi: 3.1.0
info:
  title: Bags Public API v2
  description: API endpoints for Bags platform
  version: 2.0.0
  contact:
    name: Bags Support
    url: https://support.bags.fm
servers:
  - url: https://public-api-v2.bags.fm/api/v1
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Token Launch
    description: Endpoints for creating and managing token launches
  - name: Fee Share
    description: Endpoints for managing fee sharing configs
  - name: Fee Share Admin
    description: >-
      Endpoints for fee share admin operations including listing, transferring
      admin authority, and updating configs
  - name: Analytics
    description: Endpoints for retrieving token analytics and metadata
  - name: Fee Claiming
    description: Endpoints for claiming fees from various sources
  - name: State
    description: Endpoints for retrieving on-chain state and derived state
  - name: Trade
    description: Endpoints for getting trade quotes and executing token swaps
  - name: Partner
    description: Endpoints for managing partner configurations and claiming partner fees
  - name: Solana
    description: Endpoints for direct Solana blockchain interactions
  - name: EVM
    description: Endpoints for reading Bags EVM token data
  - name: Robinhood Chain
    description: Read endpoints for Bags V2 tokens on Robinhood Chain (chain id 4663)
  - name: Dexscreener
    description: >-
      Endpoints for managing Dexscreener token info orders, payments, and image
      uploads
  - name: Bags Payout
    description: >-
      Endpoints for reading where a token's creator fees are paid out, its
      payout history, claims and payment events, and for changing its payout
      handle
  - name: Auth
    description: Endpoints for retrieving authenticated user information
  - name: Agent
    description: Endpoints for AI agent wallet-signature authentication (V2)
paths:
  /bags-payout/token/events:
    get:
      tags:
        - Bags Payout
      summary: Get Bags payout token events
      description: >-
        The payment events of one token, for example to draw markers on its
        price chart. An event is one completed end-to-end send: a Peer fill the
        buyer paid and that was released with verified cash. Only X Money
        payments are returned unless `method` says otherwise.


        **Offset Mode** (default): use `mode=offset` (or omit `mode`) with
        `limit` and `offset`. Events are ordered newest first.


        **Time Mode**: use `mode=time` with `from` and `to` unix timestamps
        (both inclusive and required). Events are ordered oldest first (chart
        order), up to 1000 events; `hasMore` is `true` when the range holds
        more.


        Sending offset parameters in time mode, or time parameters in offset
        mode, is rejected with 400.
      parameters:
        - name: tokenMint
          in: query
          required: true
          schema:
            type: string
          description: Public key of the token mint (base58)
        - name: mode
          in: query
          required: false
          schema:
            type: string
            enum:
              - offset
              - time
            default: offset
          description: >-
            Query mode: `offset` for pagination (default), `time` for a time
            range
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
          description: >-
            Maximum number of events to return (1 to 100, default 100). Only
            used with `mode=offset`
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Number of events to skip (default 0). Only used with `mode=offset`
        - name: from
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
          description: >-
            Start unix timestamp in seconds (inclusive). Required when
            `mode=time`
        - name: to
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
          description: >-
            End unix timestamp in seconds (inclusive). Required when
            `mode=time`. Must be greater than or equal to `from`
        - name: method
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/BagsPayoutEventMethodFilter'
          description: 'Payout method: `xmoney` (default), `cashapp`, `venmo` or `all`'
      responses:
        '200':
          description: Successfully retrieved the token's payout events
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessResponse'
                  - type: object
                    properties:
                      response:
                        $ref: '#/components/schemas/BagsPayoutTokenEventsPage'
        '400':
          description: >-
            Bad request - Invalid tokenMint, mode, limit, offset, from, to or
            method, `from` greater than `to`, or parameters of the other mode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BagsPayoutErrorResponse'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests - Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BagsPayoutErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BagsPayoutErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BagsPayoutEventMethodFilter:
      type: string
      enum:
        - xmoney
        - cashapp
        - venmo
        - all
      default: xmoney
      description: >-
        Payout method to return events for: `xmoney` (default), `cashapp`,
        `venmo`, or `all` for every method.
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        response:
          description: ''
      required:
        - success
    BagsPayoutTokenEventsPage:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/BagsPayoutEvent'
        hasMore:
          type: boolean
          description: >-
            Offset mode: more events exist past this page. Time mode: the range
            holds more than the 1000 events returned.
      required:
        - events
        - hasMore
    BagsPayoutErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        response:
          type: string
          description: Error message describing why the request failed.
      required:
        - success
        - response
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: Error message
      required:
        - success
        - error
    BagsPayoutEvent:
      type: object
      description: >-
        One completed end-to-end send: a Peer fill that the buyer paid and that
        was released (`FULFILLED` or `MANUALLY_RELEASED`) with verified cash.
        Claims, bridges, listed or open orders, and pending or pruned fills are
        never events. One payout can hold several events, one per buyer.
      properties:
        paymentId:
          type: string
          pattern: ^0x[0-9a-fA-F]{64}$
          description: >-
            The Peer intent hash of the fill. The same id `GET
            /bags-payout/payment?id=` takes.
          example: '0x8f3c2b7e1d4a5f6e9c0b1a2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f'
        payoutId:
          type: string
          pattern: ^[0-9a-fA-F]{24}$
          description: >-
            Id of the payout the fill belongs to, for `GET
            /bags-payout/payout?id=`.
          example: 6720f1c2a9b3e45d7f8a1b2c
        tokenMint:
          type: string
          description: Mint of the token whose fees funded the payment.
          example: CyXBDcVQuHyEDbG661Jf3iHqxyd9wNHhE2SiQdNrBAGS
        cashoutMethod:
          $ref: '#/components/schemas/BagsPayoutCashoutMethod'
        username:
          type: string
          description: The handle that was paid, without `@` or `$`.
          example: rebeccaperrotto
        displayHandle:
          type: string
          description: >-
            The handle as it should be shown: `@handle` for X Money; Venmo and
            Cash App names are shown bare.
          example: '@rebeccaperrotto'
        amountUsd:
          type: number
          description: >-
            The exact cash the recipient received, in USD. This is the verified
            amount paid, not a price estimate.
          example: 786.04
        fiatPaidCents:
          type: string
          description: The same cash amount in USD cents, as an integer string.
          example: '78604'
        usdcAmount:
          type: string
          description: Raw USDC (base units) the buyer received for the payment.
          example: '45746116'
        usdcDecimals:
          type: integer
          description: Decimals of `usdcAmount`.
          example: 6
        discountBps:
          type: integer
          description: >-
            The order's discount below the market rate, in basis points (1000 =
            10%).
          example: 1000
        timestamp:
          type: integer
          description: When the handle was paid, in unix seconds.
          example: 1794040000
        isFirstPayment:
          type: boolean
          description: >-
            Whether this is the first payment to this handle (same method) from
            this token.
          example: true
      required:
        - paymentId
        - payoutId
        - tokenMint
        - cashoutMethod
        - username
        - displayHandle
        - amountUsd
        - fiatPaidCents
        - usdcAmount
        - usdcDecimals
        - discountBps
        - timestamp
        - isFirstPayment
    BagsPayoutCashoutMethod:
      type: string
      enum:
        - venmo
        - cashapp
        - xmoney
      description: >-
        Supported payout method: `venmo` (Venmo username), `cashapp` (Cash App
        cashtag) or `xmoney` (X username with X Money enabled).
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key authentication. Provide your API key as the header value.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.