Skip to main content
POST
/
events
/
{merchant_id}
Events - List
curl --request POST \
  --url https://sandbox.hyperswitch.io/events/{merchant_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "created_after": "2023-01-01T00:00:00",
  "created_before": "2023-01-31T23:59:59",
  "event_classes": [
    "payments",
    "refunds"
  ],
  "event_types": [
    "payment_succeeded"
  ],
  "is_delivered": true,
  "limit": 5,
  "object_id": "{{object_id}}",
  "offset": 0,
  "profile_id": "{{profile_id}}"
}'
{
  "events": [
    {
      "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"
    }
  ],
  "total_count": 123
}

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.

Body

application/json

The constraints that can be applied when listing Events.

The constraints to apply when filtering events.

​
created_after
string<date-time> | null

Filter events created after the specified time.

​
created_before
string<date-time> | null

Filter events created before the specified time.

​
limit
integer | null

Include at most the specified number of events.

Required range: x >= 0
​
offset
integer | null

Include events after the specified offset.

Required range: x >= 0
​
object_id
string | null

Filter all events associated with the specified object identifier (Payment Intent ID, Refund ID, etc.)

​
profile_id
string | null

Filter all events associated with the specified business profile ID.

​
event_classes
enum<string>[] | null

Filter events by their class.

​
event_types
enum<string>[] | null

Filter events by their type.

​
is_delivered
boolean | null

Filter all events by is_overall_delivery_successful field of the event.

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

​
total_count
integer
required

Count of total events

⌘I