Xenith uses webhooks to automatically notify your application about important events related to your transactions. These events include:
- Pay In status changes (successful, expired, or failed)
- Pay Out status changes (successful or failed)
When these events occur, Xenith sends a POST request to a URL you specify (the webhook endpoint) with details about the event. This allows your application to receive real-time updates and take appropriate actions without needing to constantly poll our API.
Common Webhook Structure
All webhooks share a common structure:
| Field | Type | Description |
|---|---|---|
schemaVersion | string | Version of the webhook schema |
timestamp | string | Timestamp of the webhook event (UTC, ISO 8601 format) |
data | object | Contains transaction-specific details |
Webhook Response
Your system should immediately respond with a 200 status code upon receiving a webhook. If a failure occurs, automatic retry will kick-off for the next 24 hours. Refer to the Delivery Attempts and Retries section for more details.