Events - List

List all Events associated with a Merchant Account or Profile.

Authorizations

api-key

string

header

required

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.

Path Parameters

merchant_id

string

required

The unique identifier for the Merchant Account.

Query Parameters

created_after

string | null

Only include Events created after the specified time. Either only object_id must be specified, or one or more of created_after, created_before, limit and offset must be specified.

created_before

string | null

Only include Events created before the specified time. Either only object_id must be specified, or one or more of created_after, created_before, limit and offset must be specified.

limit

integer | null

The maximum number of Events to include in the response. Either only object_id must be specified, or one or more of created_after, created_before, limit and offset must be specified.

offset

integer | null

The number of Events to skip when retrieving the list of Events. Either only object_id must be specified, or one or more of created_after, created_before, limit and offset must be specified.

object_id

string | null

Only include Events associated with the specified object (Payment Intent ID, Refund ID, etc.). Either only object_id must be specified, or one or more of created_after, created_before, limit and offset must be specified.

profile_id

string | null

Only include Events associated with the Profile identified by the specified Profile ID.

is_delivered

boolean | null

Only include Events which are ultimately delivered to the merchant.

Response

200 - application/json

List of Events retrieved successfully

The response body of list initial delivery attempts api call.

events

object[]

required

The list of events

The response body for each item when listing events.

Show child attributes

events.event_id

string

required

The identifier for the Event.

Maximum length: 64

Example:

"evt_018e31720d1b7a2b82677d3032cab959"

events.merchant_id

string

required

The identifier for the Merchant Account.

Maximum length: 64

Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

events.profile_id

string

required

The identifier for the Business Profile.

Maximum length: 64

Example:

"SqB0zwDGR5wHppWf0bx7GKr1f2"

events.object_id

string

required

The identifier for the object (Payment Intent ID, Refund ID, etc.)

Maximum length: 64

Example:

"QHrfd5LUDdZaKtAjdJmMu0dMa1"

events.event_type

enum<string>

required

Available options:

payment_succeeded,

payment_failed,

payment_processing,

payment_cancelled,

payment_authorized,

payment_captured,

action_required,

refund_succeeded,

refund_failed,

dispute_opened,

dispute_expired,

dispute_accepted,

dispute_cancelled,

dispute_challenged,

dispute_won,

dispute_lost,

mandate_active,

mandate_revoked,

payout_success,

payout_failed,

payout_initiated,

payout_processing,

payout_cancelled,

payout_expired,

payout_reversed

events.event_class

enum<string>

required

Available options:

payments,

refunds,

disputes,

mandates,

payouts

events.initial_attempt_id

string

required

The identifier for the initial delivery attempt. This will be the same as event_id for the initial delivery attempt.

Maximum length: 64

Example:

"evt_018e31720d1b7a2b82677d3032cab959"

events.created

string

required

Time at which the event was created.

Example:

"2022-09-10T10:11:12Z"

events.is_delivery_successful

boolean | null

Indicates whether the webhook was ultimately delivered or not.

total_count

integer

required

Count of total events