Webhooks are HTTP callbacks that notify you of all events you subscribed for on an entity.
Events can be payments, state changes to payments or transactions connected to a payment (e.g. a chargeback).
For PCI compliance, SSL connections using untrusted certificates are not allowed. Please ensure you have a valid SSL certificate chain. Self-signed certificates are not valid.
This article gives you an overview and is supported by our main integration documentation for card payments webhooks, available below:
Once you are ready, please send the following details to email@example.com to get your webhooks registered and receive a decryption key :
- Technical email address
- Webhooks URL (must be HTTPS in LIVE)
- Payment types to receive notifications for (eg. Debits, refunds etc)
- Indicate your preference for JSON wrapped notifications or plain text
Some additional notes on webhook integration:
1. Upon receiving the notification to your webhook url the system will expect an HTTP 200 response.
2. Only webhooks sitting on port 80 and port 443 are guaranteed to work
3. In order to register the webhook, we send a test notification to see if the webhook is configured correctly on your side. If either one of the first two points above is not satisfied, registration will fail.
4. The test notification is a 206 character HTTP Post (Content-Length=206)
5. We require that you test the webhook in the TEST system before configuring it for LIVE.
An example notification looks like this:
Content-Type: application/json; charset=UTF-8
Via: 1.1 vegur