GET
/
events
/
{merchant_id}

Authorizations

​
api-key
string
headerrequired

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.

Response

200 - application/json
​
event_id
string
required

The identifier for the Event.

Maximum length: 64
​
merchant_id
string
required

The identifier for the Merchant Account.

Maximum length: 64
​
profile_id
string
required

The identifier for the Business Profile.

Maximum length: 64
​
object_id
string
required

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

Maximum length: 64
​
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
​
event_class
enum<string>
required
Available options:
payments,
refunds,
disputes,
mandates,
payouts
​
is_delivery_successful
boolean
required

Indicates whether the webhook delivery attempt was successful.

​
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
​
created
string
required

Time at which the event was created.

Payouts - List using filtersEvents - Delivery Attempt List