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

> List every claim transaction of a token, newest first, with cursor pagination.

Unknown query parameters are rejected.



## OpenAPI

````yaml GET /bags-payout/claims
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 and claims, 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/claims:
    get:
      tags:
        - Bags Payout
      summary: Get Bags payout claims
      description: >-
        List every claim transaction of a token, newest first, with cursor
        pagination.


        Unknown query parameters are rejected.
      parameters:
        - name: tokenMint
          in: query
          required: true
          schema:
            type: string
          description: Token mint address
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
          description: Number of claims to return (1 to 50, default 20)
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
          description: >-
            Pagination cursor: the `nextCursor` of the previous page (24 hex
            characters)
      responses:
        '200':
          description: Successfully retrieved claims
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessResponse'
                  - type: object
                    properties:
                      response:
                        $ref: '#/components/schemas/BagsPayoutClaimsPage'
        '400':
          description: >-
            Bad request - Invalid tokenMint, limit or cursor, or unknown
            parameters
          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:
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        response:
          description: ''
      required:
        - success
    BagsPayoutClaimsPage:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BagsPayoutClaimHistoryItem'
          description: Claim transactions, newest first
        hasMore:
          type: boolean
          description: Whether older items exist
        nextCursor:
          type: string
          description: Pass as `cursor` to get the next (older) page; null on the last page
          nullable: true
      required:
        - items
        - hasMore
        - nextCursor
    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
    BagsPayoutClaimHistoryItem:
      type: object
      properties:
        id:
          type: string
          description: Claim id (24 hex), also the pagination cursor
        tokenMint:
          type: string
          description: Token mint address
        status:
          type: string
          description: Claim status
          enum:
            - sent
            - confirmed
            - failed
            - expired
            - manual_review
        signature:
          type: string
          description: Claim transaction signature, only once the transaction landed
          nullable: true
        slot:
          type: integer
          description: Slot the claim landed in, or null
          nullable: true
        expectedLamports:
          type: string
          description: >-
            Quoted claimable lamports for the whole claim set this transaction
            belongs to, as string to support bigint. Every transaction of the
            set repeats it: compare with the sum of the set's `claimedLamports`,
            not per row.
        txIndex:
          type: integer
          description: 0-based position of this transaction in its claim set
        txCount:
          type: integer
          description: Number of transactions in the claim set
        claimedLamports:
          type: string
          description: >-
            Measured gross lamports, as string to support bigint. Confirmed
            claims only.
          nullable: true
        cashoutMethod:
          $ref: '#/components/schemas/BagsPayoutCashoutMethod'
        username:
          type: string
          description: Payout handle frozen on this claim
        payoutId:
          type: string
          description: The payout this claim funds, once linked
          nullable: true
        createdAt:
          type: string
          description: ISO timestamp the claim was created
        confirmedAt:
          type: string
          description: ISO timestamp the claim was confirmed, or null
          nullable: true
      required:
        - id
        - tokenMint
        - status
        - signature
        - slot
        - expectedLamports
        - txIndex
        - txCount
        - claimedLamports
        - cashoutMethod
        - username
        - payoutId
        - createdAt
        - confirmedAt
    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.