Event object

Events are created when objects are created or updated. They can be retrieved using the API or sent to your webhook(s). Events have a topic and a type. The topic corresponds to the object that has been created or updated. The type corresponds to the exact type of update.

Learn more about events in the Webhooks section.

AttributeDescription
id
string
The event ID.
object
string
Always event.
topic
string
The event topic.
type
string
The event type.
related_object_type
string
The related object type, e.g. payment_order or transaction.
related_object_id
string
The related object ID.
status
string
The event status.
status_details
string
The event status details.
created_at
datetime
The event creation timestamp.
data
object
The payload of the object created or updated.

Below is an example of an event:

{
   "id": "35bb6411-290d-478e-a478-2f84146c2ddf",
   "object": "event",
   "topic": "payment_order",
   "type": "executed",
   "related_object_id": "25102c0f-fc25-44e7-9402-cae6d61ad47f",
   "related_object_type": "payment_order",
   "status": "delivered",
   "status_details": "",
   "created_at": "2023-02-01T17:13:15.087995Z",
   "data": {
      "id": "25102c0f-fc25-44e7-9402-cae6d61ad47f",
      "idempotency_key": "",
      "object": "payment_order",
      "connected_account_id": "a0d22970-3b30-44c9-a5ea-fac6707f6b80",
      "connected_account": "a0d22970-3b30-44c9-a5ea-fac6707f6b80",
      "type": "sepa",
      "direction": "credit",
      "amount": 75000,
      "currency": "EUR",
      "reference": "Invoice ID 89230927",
      "value_date": "2023-02-01",
      "originating_account": {
         "bank_code": "SOGEFRPP",
         "holder_name": "SoftwareCo",
         "account_number": "FR7601234567890627967100010",
         "holder_address": {
            "line_1": "1, rue de l'Abondance",
            "line_2": "",
            "postal_code": "69003",
            "city": "Lyon",
            "region_state": "",
            "country": "FR"
         }
      },
      "receiving_account_id": "",
      "receiving_account": {
         "bank_code": "BNPAFRPPXXX",
         "holder_name": "PartnerCo",
         "account_number": "FR7601234567891127967100082",
         "holder_address": {
            "line_1": "1, rue de la Bourse",
            "line_2": "",
            "postal_code": "59000",
            "city": "Lille",
            "region_state": "",
            "country": "FR"
         }
      },
      "direct_debit_mandate": null,
      "status": "executed",
      "status_details": "",
      "auto_approval": false,
      "reconciliation_status": "unreconciled",
      "reconciled_amount": 0,
      "metadata": {},
      "bank_data": {
         "file_id": "b251f19a-55a4-459a-8fb0-8dc2b72443d4",
         "message_id": "230201030031Fzmc",
         "end_to_end_id": "25102c0ffc2544e79402cae6d61ad47f",
         "transaction_id": "25102c0ffc2544e79402cae6d61ad47f",
         "original_instruction_id": "25102c0ffc2544e79402cae6d61ad47f"
      },
      "created_at": "2023-02-01T17:10:00.248706Z"
   }
}