Skip to main content

Overview

Events provide an audit trail of activity (payments, invoices, commerce order updates, etc.). Use these endpoints when you need to:
  • backfill history
  • build dashboards/reconciliation tools
  • debug an integration

Authentication

Events can be accessed with:
  • x-api-key: pk_... (merchant scope)
  • x-commerce-api-key: ck_... (commerce scope)

Request

Endpoints:
  • GET /api/v1/events
  • GET /api/v1/events/{eventId}
Example (list):

Response

Representative event list response:

Errors

  • 401/403 missing/invalid auth
  • 400 invalid pagination parameters

Examples

Use Events for historical backfills; for realtime delivery, prefer WebSockets or webhook delivery (Commerce). Next: Commerce overview