List Events

GET /api/v1/events

Overview

Retrieves a paginated list of events with optional filtering by offset and limit parameters.

Authorization

Header: Authorization: Bearer $PAYBYTOKEN_SECRET_KEY

Request Details

Request

curl "https://api-prod.paybytoken.io/api/v1/events?offset=0&limit=10" \
  -X GET \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY"

Request Parameters

Parameter	Type	Description
`offset`	number	Starting point for pagination.
`limit`	number	Maximum number of events to return per page.

Response Details

Response

The response returns a paginated list of Event objects containing details about platform activities. See Events Overview for the full object definition.

Attributes

Attribute	Type	Description
`total`	number	Total number of events available.
`data`	array	Array of event objects.

Example Response

{
  "total": 2,
  "data": [
    {
      "id": "evt_pe3C6ngyvcfAvNeW",
      "account_id": "p226968785",
      "resource_type": "payment_intent",
      "resource_id": "pay_pe337Vo53qcUJInIr4i3",
      "type": "payment_intent.succeeded",
      "api_version": "v1",
      "livemode": 0,
      "data": {
        "id": "pay_pe337Vo53qcUJInIr4i3",
        "object": "payment_intent",
        "status": "succeeded"
      },
      "created_at": "2025-09-25T11:44:10.000Z",
      "updated_at": "2025-09-25T19:44:10.000Z"
    },
    {
      "id": "evt_pe3C6u8Q829ChavN",
      "account_id": "p226968785",
      "resource_type": "checkout_session",
      "resource_id": "chk_test_pe2oc1qiz5zGYBA61QVDfE0J",
      "type": "checkout_session.expired",
      "api_version": "v1",
      "livemode": 0,
      "data": {
        "id": "chk_test_pe2oc1qiz5zGYBA61QVDfE0J",
        "object": "checkout_session",
        "status": "expired",
        "payment_intent": {
          "id": "pay_pe337Vo53qcUJInIr4i3",
          "chain": "bnb_chain",
          "amount": "10000000000000000000",
          "status": "succeeded",
          "address": "0x64FD61E535b37bbd9d688d8300Ece3C2681E4f65",
          "currency": "USDC",
          "payer_address": "0x9AD1DDA7c26D7577877b6011DC742B40b0144930"
        },
        "payment_intent_id": "pay_pe337Vo53qcUJInIr4i3"
      },
      "created_at": "2025-09-25T11:44:10.000Z",
      "updated_at": "2025-09-25T19:44:10.000Z"
    }
  ]
}

Errors

HTTP Status	Error Code	Description
400	400	Invalid query parameters.
500	500	Internal server error.