Sign in

v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Event

Events - List

List all Events associated with a Merchant Account or Profile.

post/events/{merchant_id}

Path parameters

merchant_idstring required

The unique identifier for the Merchant Account.

Request body

created_afterstring date-time nullable

Filter events created after the specified time.

created_beforestring date-time nullable

Filter events created before the specified time.

limitinteger nullable

Include at most the specified number of events.

offsetinteger nullable

Include events after the specified offset.

object_idstring nullable

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

event_idstring nullable

Filter all events associated with the specified Event_id

profile_idstring nullable

Filter all events associated with the specified business profile ID.

event_classesEventClass[] nullable

Filter events by their class.

event_typesEventType[] nullable

Filter events by their type.

is_deliveredboolean nullable

Filter all events by is_overall_delivery_successful field of the event.

recipient'merchant' | 'connector'

Response

List of Events retrieved successfully

total_countinteger required

Count of total events

Example response

{
  "events": [
    {
      "event_id": "evt_018e31720d1b7a2b82677d3032cab959",
      "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
      "profile_id": "SqB0zwDGR5wHppWf0bx7GKr1f2",
      "object_id": "QHrfd5LUDdZaKtAjdJmMu0dMa1",
      "initial_attempt_id": "evt_018e31720d1b7a2b82677d3032cab959",
      "created": "2022-09-10T10:11:12Z"
    }
  ]
}