GET
List events

Authorizations

Authorization
string
header
default:sk_test_docs_246e232c64ccc7a001bf61ec0f2e6ab0
required

Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown once when created in the dashboard, and are scoped (see x-required-scope on each operation). Keep them on your server. Live keys are issued after your business is verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

The next_cursor from the previous page

type
enum<string>

New event types may be added. Ignore types you don't handle.

Available options:
checkout_session.expired,
escrow.funded,
milestone.delivered,
milestone.released,
escrow.completed,
escrow.refunded,
dispute.opened,
dispute.evidence_requested,
dispute.evidence_submitted,
dispute.resolved,
payout.sent,
refund.sent,
refund.failed,
chargeback.opened,
chargeback.closed,
payout.failed
created_gte
string<date-time>

Response

A page of events

object
string
required
Allowed value: "list"
has_more
boolean
required
next_cursor
string | null
required

Pass as cursor to get the next page; null on the last page

data
object[]
required