v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Events

List events

List and filter events.

get/events

Query parameters

limitinteger

starting_afterstring

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

status'created' | 'delivered' | 'pending_retry' | 'failed' | 'archived'

The status of the event.

topicstring

The topic of the event.

typestring

The type of the event.

related_object_idstring

The ID of the object related to the event.

webhook_idstring

The ID of the webhook that received the event.

start_datestring date

The creation date of the event.

end_datestring date

The creation date of the event.

Response

List of filtered events.

idstring

objectstring

created_atstring

topicstring

typestring

statusstring

{"stackTrail":"paths:/events:get:responses:200:content:application/json:schema:properties:status_details","oasType":"schema","type":"unknown"}

Example response

{
  "id": "7c7c189f-8520-48f9-8ab8-9f6384509eba",
  "object": "event",
  "created_at": "2021-01-01T00:11:07Z",
  "topic": "payment_order",
  "type": "approved",
  "status": "delivered",
  "data": {
    "id": "9482351c-9a4c-45d9-8fa8-50a50843e593",
    "object": "payment_order",
    "connected_account_id": "050b18a2-fe5a-47c5-8692-50cf6663c259",
    "type": "sepa",
    "direction": "credit",
    "amount": 10000,
    "currency": "eur",
    "status": "approved",
    "origin": {
      "account_number": "FR7630004000031234567890143",
      "bank_code": "BNPAFRPPXXX",
      "holder_name": "Acme Corporation",
      "holder_address": "1, rue de la Paix, 75002 Paris, France"
    },
    "destination": {
      "account_number": "FR7630056009271234567890182",
      "bank_code": "CCBPFRPPMTZ",
      "holder_name": "Jane Doe",
      "holder_address": "1, avenue des Champs Elysées, 75008 Paris, France"
    },
    "purpose": "Lorem ipsum dolor sit amet",
    "created_at": "2021-01-01T00:11:07Z"
  }
}