Consuming webhooks

N-Genius Online Online supports webhooks — secure server-to-server notifications that alert your systems the moment something important happens with an order. This lets you automatically update your backend, notify customers, and eliminate the need for manual reconciliation or polling logic.

Introduction

What Are Webhooks?

Webhooks are server-to-server notifications sent by N-Genius Online when key events occur on an order — such as a successful payment, a failed capture, or a refund.

By listening for these real-time events, your systems can automatically react without polling, making your integration more efficient and responsive.

Whether you're using the Hosted Payment Page, creating orders via API, or issuing invoices from the portal, webhooks can keep your backend in sync with payment activity.

Why Use Webhooks?

Webhooks help you:

• Get notified when a payment succeeds — even if the customer doesn't return to your site.
• Monitor the status of invoices created manually or via API.
• Automate downstream processes like order fulfilment, notifications, and reporting.
• Eliminate the need for polling endpoints or checking the dashboard manually.

How Webhooks Work in N-Genius Online

When webhooks are enabled for your account, N-Genius Online will send an HTTP POST request to your configured endpoint every time a supported event occurs. The payload contains details about the order and the event type.

⚠️

N-Genius Online sends a single webhook per event — there are no retries if your server is unavailable or does not respond.

Delivery Behaviour

• You will receive one POST request per event.
• Events may be sent in quick succession (e.g. AUTHORISED followed by CAPTURED).
• You must respond with HTTP status code 200 or 201 within 15 seconds to acknowledge receipt.

Configuring Webhooks

You can create and manage webhooks in the N-Genius Online portal:

1. Log in to your merchant dashboard.
2. Navigate to Settings > Integrations > Webhooks.
3. Click New to create a new webhook.

Fill in the following fields:

Once submitted, your webhook URL will be reviewed and whitelisted before it becomes active.

📘

Webhooks require whitelisting

After creating a webhook, our team will validate and approve your endpoint. Once approved, you will begin receiving event notifications.

Supported Webhook Events

Here is a list of events that can trigger a webhook:

🌀

You may receive multiple events for a single order. Ensure your application handles them idempotently.

Handling Webhooks and Sample Payloads

Receiving a Webhook

When your endpoint receives a webhook request from N-Genius Online:

1. Read the request body — it's in JSON format and contains the event details.
2. Verify the event — check the event type and ensure it’s one your system can handle.
3. Respond quickly — return an HTTP 200 or 201 status code within 15 seconds to acknowledge successful receipt.

Here’s a sample webhook payload:

{
  "event": "CAPTURED",
  "order": {
    "reference": "ORD-123456",
    "id": "abc123xyz",
    "amount": {
      "currencyCode": "AED",
      "value": 10000
    }
  },
  "transaction": {
    "id": "txn789",
    "state": "CAPTURED",
    "date": "2024-12-01T13:22:45Z"
  },
  "timestamp": "2024-12-01T13:22:45Z"
}

⚠️

Webhook payloads are not signed. If you're concerned about security, use a secret header (configured in the portal) to validate that the request is coming from N-Genius Online.

Testing Webhooks

Currently, webhook simulation is not supported from the dashboard. We recommend:

• Triggering real transactions in a sandbox environment.
• Using tools like Webhook.site to inspect incoming requests during development.

Best Practices

• Make your webhook handler idempotent
  Each event should only be processed once, even if accidentally triggered again.
• Respond quickly
  Always reply with a 200 or 201 status code within 15 seconds — even if internal processing takes longer.
• Log everything
  Store logs of all received events and responses for easier debugging and auditing.
• Use secret headers
  Add a custom header and value to your webhook config to verify requests originate from N-Genius Online.
• Handle unknown events gracefully
  Don’t crash your app if you receive a new event type — log and skip it.

Common Pitfalls

• ❌ Assuming a single event: A single payment might trigger multiple events (AUTHORISED, CAPTURED, etc.).
• ❌ Expecting retries: N-Genius Online does not retry failed webhooks. If your server is down, the event is lost.
• ❌ Failing to validate payloads: Don’t trust the request blindly — always verify it.
• ❌ Delaying responses: Avoid long processing before sending an HTTP 200. Acknowledge first, process after.