An event is created when an object is created or updated, either by a user using the API or the dashboard or by Mambu Payments. An update can be the update of any attribute, such as a status, a date, or any other data. An event takes the form of an Event object which can be retrieved using the API and / or sent to your webhooks.

1. Anatomy of an event

The Event object has four key attributes:

topic corresponding to the type of the related object
type describing the action that happened
related_object_id including the ID of the object created or update
data containing the entire object created or updated

Below is an example of an event related to a payment order that has been created and is pending approval:

{
  "id": "ee04cd34-8474-48d4-b0fe-811c82fcafd1",
  "object": "event",
  "topic": "payment_order",
  "type": "pending_approval",
  "status": "delivered",
  "status_details": "",
  "related_object_id": "1391efba-40ff-4b16-a819-6c18a1490092",
  "related_object_type": "payment_order",
  "data": {
    "id": "1391efba-40ff-4b16-a819-6c18a1490092",
    "object": "payment_order",
    "amount": 31483,
    "currency": "EUR",
		"type": "sepa_instant",
    "status": "pending_approval",
    […]
  },
  "created_at": "2022-06-24T10:23:57.450103Z",
}

ℹ️
In order to guarantee the robustness of your integration, we recommend building a flexible parser as attributes might be added or change position without notice.

2. Existing events

Topic	Lifecycle events
`payment_order`	Payment order lifecycle
`incoming_payment`	Incoming payment lifecycle
`return`	Return lifecycle
`return_request`	Return request lifecycle
`inquiry`	Inquiry lifecycle
`claim`	Claim lifecycle
`balance`	Balance lifecycle
`transaction`	Transaction lifecycle
`reconciliation`	Reconciliation lifecycle
`expected_payment`	Expected payment lifecycle
`payment_capture`	Payment capture lifecycle
`account_holder`	Account holder lifecycle
`internal_account`	Internal account lifecycle
`external_account`	External account lifecycle
`direct_debit_mandate`	Direct debit mandate lifecycle
`payee_verification_request`	Payee verification request lifecycle
`bulk_action`	Bulk action lifecycle
`connectivity_sync`	Connectivity sync lifecycle

3. Using events

Events can be:

Retrieved using the List events and Retrieve event API endpoints
Send to a webhook exposed by your application

What's next

What's next