ePayment webhook events
The ePayment API offers the possibility to subscribe to the following webhooks:
Name | Event Type |
---|---|
Created | epayments.payment.created.v1 |
Aborted | epayments.payment.aborted.v1 |
Expired | epayments.payment.expired.v1 |
Cancelled | epayments.payment.cancelled.v1 |
Captured | epayments.payment.captured.v1 |
Refunded | epayments.payment.refunded.v1 |
Authorized | epayments.payment.authorized.v1 |
Terminated | epayments.payment.terminated.v1 |
We support up to 25 webhook registrations per event.
The process:
- You register a webhook URL
- We send updates and information to the webhook URL you have specified
Please note
Webhooks offer a faster user experience than polling, but you
should not rely on webhooks alone.
In the rare cases where webhooks may be delayed, you should poll the relevant
API to get the information you need:
GET:/epayment/v1/payments/{reference}
.
Depending on your use case, you should set an appropriate timeout for webhooks. If the webhook is not received within that time, you should start polling.
Please follow our polling guidelines.
For any webhook, you will receive the following payload, where the only property changing is
the name
, which will reflect the event type you subscribed on.
See also: