Skip to main content

Register Webhook URL

This endpoint allows you to register a webhook URL for notifications.

Endpoint​

POST /WebhookRegistration/RegisterWebhook

Headers​

Authorization: Bearer

To authorize this API request, you need to include your apiKey as a bearer token. This is done by setting the Authorization header in your request. The header should have the format:

Authorization: "Bearer your_api_key"

Note: Get your API key from Settings > API Keys in your dashboard.

Request Body​

  • webhookUrl (string): The URL to which the webhook events will be sent.
  • merchantId (number): The ID of the merchant.
  • secret (string): The secret key for securing the webhook.
Request Body
  {
    "webhookUrl": "https://ejeiokekeemmanuel.vercel.app",
    "merchantId": 12,
    "secret": "string"
  }
Response (200) - Success
  {
    "responseCode": "00",
    "responseMessage": "Webhook registered successfully",
    "data": {
      "webhookUrl": "https://ejeiokekeemmanuel.vercel.app/",
      "webhookPublisher": "XpressPay"
    }
  }