> ## 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 Tokens (Bulk)

> Get the payout token view for up to 100 tokens in one call. The response has one entry per requested mint in request order, `null` for a mint with no payout handle.



## OpenAPI

````yaml POST /bags-payout/token/bulk
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/token/bulk:
    post:
      tags:
        - Bags Payout
      summary: Get Bags payout tokens (bulk)
      description: >-
        Get the payout token view for up to 100 tokens in one call. The response
        has one entry per requested mint in request order, `null` for a mint
        with no payout handle.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BagsPayoutTokenBulkRequest'
      responses:
        '200':
          description: Successfully retrieved payout tokens, in the order requested
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessResponse'
                  - type: object
                    properties:
                      response:
                        type: array
                        items:
                          $ref: '#/components/schemas/BagsPayoutTokenView'
                          nullable: true
                        description: >-
                          One entry per requested mint, in request order; null
                          when the mint has no payout handle
        '400':
          description: >-
            Bad request - tokenMints must contain 1 to 100 valid token mint
            addresses, or unknown fields
          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:
    BagsPayoutTokenBulkRequest:
      type: object
      properties:
        tokenMints:
          type: array
          items:
            type: string
            description: Token mint address
          description: Token mint addresses to look up
          minItems: 1
          maxItems: 100
      required:
        - tokenMints
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        response:
          description: ''
      required:
        - success
    BagsPayoutTokenView:
      type: object
      properties:
        tokenMint:
          type: string
          description: Token mint address
        cashoutMethod:
          $ref: '#/components/schemas/BagsPayoutCashoutMethod'
        cashoutMethodLabel:
          type: string
          description: Display label of the method
          enum:
            - Venmo
            - Cash App
            - X Money
        username:
          type: string
          description: Payout handle as entered by the creator
        status:
          type: string
          description: Whether payouts for this token are active or disabled
          enum:
            - active
            - disabled
        paysPayoutBot:
          type: boolean
          description: >-
            Whether the token's on-chain SOL fee-share config names the payout
            wallet as its only fee claimer (100%), read live. A saved handle
            alone is not proof: the config may name other claimers or be changed
            later. `false` also before the config exists; `null` when it could
            not be read. Treat the handle as where fees go only when this is
            `true`.
          nullable: true
        stats:
          $ref: '#/components/schemas/BagsPayoutTokenStats'
        pendingClaims:
          type: array
          items:
            $ref: '#/components/schemas/BagsPayoutPendingClaims'
          description: Claimed fees not in a payout yet (empty when none)
        createdAt:
          type: string
          description: ISO timestamp the payout handle was first saved
        updatedAt:
          type: string
          description: ISO timestamp of the last update
      required:
        - tokenMint
        - cashoutMethod
        - cashoutMethodLabel
        - username
        - status
        - paysPayoutBot
        - stats
        - pendingClaims
        - createdAt
        - updatedAt
    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
    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).
    BagsPayoutTokenStats:
      type: object
      properties:
        totalClaimedLamports:
          type: string
          description: Total fees claimed, in lamports, as string to support bigint
        confirmedClaimCount:
          type: integer
          description: Number of confirmed claim transactions
        totalBridgedLamports:
          type: string
          description: Total lamports bridged to USDC, as string to support bigint
        totalUsdcReceivedRaw:
          type: string
          description: >-
            Total USDC received from bridging, in USDC base units (6 decimals),
            as string to support bigint
        totalUsdcPaidRaw:
          type: string
          description: >-
            USDC delivered to the recipient, in USDC base units (6 decimals), as
            string to support bigint
        totalFiatPaidCents:
          type: string
          description: >-
            Verified fiat paid to the recipient, in USD cents, as string to
            support bigint
        payoutCount:
          type: integer
          description: Number of payouts created
        paidPayoutCount:
          type: integer
          description: Number of payouts fully paid
        openPayoutCount:
          type: integer
          description: Number of payouts not yet finished
        lastClaimAt:
          type: string
          description: ISO timestamp of the latest claim, or null
          nullable: true
        lastPayoutAt:
          type: string
          description: ISO timestamp of the latest payout, or null
          nullable: true
        lastPaidAt:
          type: string
          description: ISO timestamp of the latest payment to the recipient, or null
          nullable: true
      required:
        - totalClaimedLamports
        - confirmedClaimCount
        - totalBridgedLamports
        - totalUsdcReceivedRaw
        - totalUsdcPaidRaw
        - totalFiatPaidCents
        - payoutCount
        - paidPayoutCount
        - openPayoutCount
        - lastClaimAt
        - lastPayoutAt
        - lastPaidAt
    BagsPayoutPendingClaims:
      type: object
      properties:
        cashoutMethod:
          $ref: '#/components/schemas/BagsPayoutCashoutMethod'
        username:
          type: string
          description: Payout handle these claims are frozen to
        isCurrentMapping:
          type: boolean
          description: >-
            True only while this handle is the token's active payout handle: its
            claims keep accumulating and are paid out once they are worth the
            regular minimum (5 USDC). False when the token now names another
            handle or payouts are disabled: the group can no longer grow and is
            paid from the lower 1 USDC minimum, still to this frozen handle.
        confirmedCount:
          type: integer
          description: Confirmed claims waiting for a payout
        confirmedLamports:
          type: string
          description: >-
            Gross lamports of the confirmed claims waiting for a payout, as
            string to support bigint
        inFlightCount:
          type: integer
          description: Claim transactions whose outcome is not known yet
        underReviewCount:
          type: integer
          description: >-
            Claims that landed but whose measured amount must be confirmed
            first. Their amount is not in `confirmedLamports`.
        oldestAt:
          type: string
          description: ISO timestamp of the oldest waiting claim, or null
          nullable: true
        newestAt:
          type: string
          description: ISO timestamp of the newest waiting claim, or null
          nullable: true
      required:
        - cashoutMethod
        - username
        - isCurrentMapping
        - confirmedCount
        - confirmedLamports
        - inFlightCount
        - underReviewCount
        - oldestAt
        - newestAt
  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.