GET
/
events
/
{merchant_id_or_profile_id}
curl --request GET \
  --url https://sandbox.hyperswitch.io/events/{merchant_id_or_profile_id} \
  --header 'api-key: <api-key>'
[
  {
    "event_id": "evt_018e31720d1b7a2b82677d3032cab959",
    "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
    "profile_id": "SqB0zwDGR5wHppWf0bx7GKr1f2",
    "object_id": "QHrfd5LUDdZaKtAjdJmMu0dMa1",
    "event_type": "payment_succeeded",
    "event_class": "payments",
    "is_delivery_successful": true,
    "initial_attempt_id": "evt_018e31720d1b7a2b82677d3032cab959",
    "created": "2022-09-10T10:11:12Z"
  }
]

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_or_profile_id
string
required

The unique identifier for the Merchant Account or Business Profile

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.

Response

200 - application/json
event_id
string
required

The identifier for the Event.

merchant_id
string
required

The identifier for the Merchant Account.

profile_id
string
required

The identifier for the Business Profile.

object_id
string
required

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

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
event_class
enum<string>
required
Available options:
payments,
refunds,
disputes,
mandates
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.

created
string
required

Time at which the event was created.