Webhooks allow you to receive Pay Advantage events to endpoints that you host. The current list of events are detailed below. Please check from time to time as these will be updated occasionally.
|
Event |
Description |
Enum name |
|---|---|---|
|
Endpoint Armed |
Fired every time an endpoint passes the arming process. The arming process is initiated when an endpoint is registered or re-registered. |
|
|
Customer Created |
Fired every time a new customer is created. |
|
|
Payment Created |
Fired every time a payment is created. |
|
|
Payment Failure |
Fired every time a payment fails. |
|
Push or Pull
There are two ways to utilise Webhooks, either “Push” or “Pull”. Most users will implement only push Endpoints whereby Pay Advantage pushes the data to your endpoints. Pull is used for those who cannot host an endpoint but can query and manage the events manually via the API. Pull is not difficult, but still more work for the developer and is prone to errors (e.g. missing or double-processing events).
Retention Time
It is very important to understand that Webhook Events are only short lived. Once an event has been accepted by all active Endpoints it is eligible for deletion. Any Event older than 1 month is eligible for deletion; even if it has not been accepted.
Comments
0 comments
Please sign in to leave a comment.