An event
is created and sent via webhook when an object is created or updated.
Each event has a topic
, corresponding to the type of the object that has been created or updated, and a type
, corresponding to the nature of the event itself. The object created or updated is nested into the event
object.
You can find more information in the Webhooks section.
Attribute | Description |
---|---|
id string | The UUID of the event. |
object string | Here event . |
topic string | The topic of this event. |
type string | The type of this event. |
status string | The status of this event. |
status_details string | The details of the status of this event. |
created_at datetime | The UTC timestamp of the creation of this event. |
data object | Contains the object that has been created or updated. |
related_object_id string | The UUID of the object associated with the event. |
related_object_type string | The type of the object associated with the event. |
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",
},
}