List events

Retrieves a paginated list of the events raised for every member of the caller's auth group, newest first. These are the same events the webhook channel delivers, so this resource is both the recovery path for an endpoint that was down and the only integration route for a client that does not run one. An event is recorded whether or not an endpoint is registered and whatever the delivery outcome was. id matches the id in the webhook body, so the two can be deduplicated together, and data is that body's data block verbatim. relatedObjectType names the kind of object the event is about and relatedObjectId is that object's id in this API: for payment.received.v1 the related object is the inbound payment. occurredAt is when the business fact was recorded; createdAt is when the event was raised on the channel and is the field to poll on, because events can be raised slightly out of occurredAt order. Events are readable for 90 days after they were raised.

Query Params
string | null

Optional; when present must name a member of the caller's group and scopes the results to that member alone

string | null

Filter to events of this type, for example payment.received.v1

string | null

Filter to events about this object

string | null

Filter to events about this kind of object: InboundPayment, OutboundPayment, InternalPayment, FxTrade, Transaction, SubAccountRequest, VirtualAccountRequest

date-time | null

Filter to events that occurred at or after this instant

date-time | null

Filter to events that occurred at or before this instant

date-time | null

Filter to events raised at or after this instant

date-time | null

Filter to events raised at or before this instant

int32

1-based page number (default 1, max 100000)

int32

Page size, 1-200 (default 50)

string

Sort key: createdAt, occurredAt (default createdAt)

string

Sort direction: asc, desc (default desc)

Headers
string
required

Fresh RFC 9449 proof JWT (ES256) signed with the client's DPoP key, binding this request's method and URL to the access token; generate a new proof per request

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json