AeronPay Webhooks Documentation

Overview

AeronPay provides real-time webhook notifications for payment and refund transactions. These webhooks allow you to receive instant updates regarding transaction statuses directly to your server.

To integrate webhooks, you must configure a valid HTTPS endpoint that is publicly accessible. AeronPay will send data via an HTTP POST request to your specified endpoint.

Webhook Events

Depending on the API version configured in your AeronPay dashboard, webhooks will be triggered for the following events:

Event Status	Status Code	Event Message
✅ `SUCCESS`	`200`	`Transaction Successful`
❌ `FAILED`	`400`	`Transaction Failed`
🚫 `REJECTED`	`450`	`Transaction Rejected`

Webhook Response Samples

🟢 Success Response

{
   "status": "SUCCESS",
   "statusCode": "200",
   "transactionId": "ARNPYXXXXXXX8669",
   "client_referenceId": "9582948592",
   "acknowledged": "1",
   "utr": "322017636298",
   "description": "Transaction Successful"
}

🔴 Failed Response

{
   "status": "FAILED",
   "statusCode": "400",
   "transactionId": "ARNPYXXXXXX41390",
   "client_referenceId": "3662648264",
   "description": "Transaction Failed"
}

⬛ Rejected Response

{
   "status": "REJECTED",
   "statusCode": "450",
   "transactionId": "ARNPYXXXXXXX8573",
   "client_referenceId": "572745837",
   "description": "Transaction Rejected"
}

Webhook Authentication 🔒

AeronPay enforces Basic HTTP Authentication for webhook security. You must provide a username and password while configuring the webhook URL.

Authentication Requirements:

Both username and password are mandatory.
Special characters like @ should not be used in the username.

Handling Webhook Failures ⚠️

If your server is unreachable or returns a non-200 response, the webhook notification will be marked as Failed in the AeronPay dashboard.
Ensure your webhook responds with a 200 status code to confirm successful delivery.
You can check webhook failures in Dashboard > Webhooks Tab.

Configuring Webhooks ⚙️

Navigate to: Dashboard > Settings > Webhooks
Enter your webhook URL (must be HTTPS)
Set up authentication (Username & Password required)
Select API Version (Ensure compatibility with your integration)
Save and Test webhook functionality

Security & Best Practices 🛡️

✔ Always validate incoming webhook requests before processing.
✔ Use HTTPS endpoints to ensure secure communication.
✔ Log webhook payloads for debugging but avoid storing sensitive information.
✔ Implement retry mechanisms in case of failures.

Need Help? 🤝

For assistance, contact our Technical Support Team via email at [email protected] or refer to our API Documentation.