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.

GET /bags-payout/token/events

Get Bags payout token events

cURL

curl --request GET \
  --url https://public-api-v2.bags.fm/api/v1/bags-payout/token/events \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "response": {
    "events": [
      {
        "paymentId": "0x8f3c2b7e1d4a5f6e9c0b1a2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f",
        "payoutId": "6720f1c2a9b3e45d7f8a1b2c",
        "tokenMint": "CyXBDcVQuHyEDbG661Jf3iHqxyd9wNHhE2SiQdNrBAGS",
        "cashoutMethod": "venmo",
        "username": "rebeccaperrotto",
        "displayHandle": "@rebeccaperrotto",
        "amountUsd": 786.04,
        "fiatPaidCents": "78604",
        "usdcAmount": "45746116",
        "usdcDecimals": 6,
        "discountBps": 1000,
        "timestamp": 1794040000,
        "isFirstPayment": true
      }
    ],
    "hasMore": true
  }
}

Authorizations

x-api-key · string · header · required

API key authentication. Provide your API key as the header value.

Query Parameters

tokenMint · string · required

Public key of the token mint (base58)

mode · enum<string> · default: offset

Query mode: offset for pagination (default), time for a time range

Available options: offset, time

limit · integer · default: 100

Maximum number of events to return (1 to 100, default 100). Only used with mode=offset

Required range: 1 <= x <= 100

offset · integer · default: 0

Number of events to skip (default 0). Only used with mode=offset

Required range: x >= 0

from · integer

Start unix timestamp in seconds (inclusive). Required when mode=time

Required range: x >= 0

to · integer

End unix timestamp in seconds (inclusive). Required when mode=time. Must be greater than or equal to from

Required range: x >= 0

method · enum<string> · default: xmoney

Payout method: xmoney (default), cashapp, venmo or all Payout method to return events for: xmoney (default), cashapp, venmo, or all for every method.

Available options: xmoney, cashapp, venmo, all

Response

200

application/json

Successfully retrieved the token's payout events

success · boolean · required

Example:

true

response · object

Show child attributes