Skip to main content
GET
/
events
/
{merchant_id}
Events - List
curl --request GET \
  --url https://api.test.switch.vaultera.co/events/{merchant_id} \
  --header 'api-key: <api-key>'
{
  "events": [
    {
      "event_id": "evt_018e31720d1b7a2b82677d3032cab959",
      "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
      "profile_id": "SqB0zwDGR5wHppWf0bx7GKr1f2",
      "object_id": "QHrfd5LUDdZaKtAjdJmMu0dMa1",
      "event_type": "payment_succeeded",
      "event_class": "payments",
      "initial_attempt_id": "evt_018e31720d1b7a2b82677d3032cab959",
      "created": "2022-09-10T10:11:12Z",
      "is_delivery_successful": true
    }
  ],
  "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.

Query Parameters

​
created_after
string<date-time> | 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<date-time> | 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<int64> | 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<int64> | 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

​
total_count
integer<int64>
required

Count of total events