Webhooks
Webhooks provide real-time notifications for API events, enabling your platform to receive timely updates about specific activities. Our system sends these notifications to a designated endpoint within your hosted environment, which is configured to adeptly receive and process them.
Leverage webhooks to promptly obtain information about critical API events. These events include occurrences external to your system, such as a new deposit in an MPC wallet or a card transaction at a point-of-sale (POS) terminal.To seamlessly receive and process webhook-enabled events, you need to establish and configure a webhook endpoint within your environment.
Each webhook request consists of a common part and a custom payload specific to the event being communicated. The common part includes standard information such as the event type, sub-type, status and a unique Id of of the notification, while the custom payload contains detailed data relevant to the specific event.
Field | Type | Description |
operation | String | Indicator of the operation being informed |
sub_operation | String | Indicator of the activity of the operation being informed |
operation_id | String | Unique identifier of the operation |
status | String | Status of the transaction. Possible values: SUCCESS | CANCELLED | FAILED |
reason | String | If the status is FAILED the reason of why ll appear here |
data | Object | Variable payload of the notification. The content of this will change depending of the notification type. Complete specification of this will be inside each notification page. |
General payload example:
{ "operation": "TREASURY", "sub_operation": "DEPOSIT", "operation_id": "ca0c57d2-b1c9-4bcd-9d5d-8d361cad6fddds1c", "status": "FINISHED", "data": { }}What made this section unhelpful for you?
On this page
- Webhooks