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.
|Endpoint Armed||Fired every time an endpoint passes the arming process.|
The arming process is initiated when an endpoint is registered or re-registered with Pay Advantage.
|Payment Created||Sent every time a payment is created.||payment.created|
|Payment Failure||Sent every time a payment fails.||payment.failed|
|Payment Settled||Sent every time a payment settles. Please note that a payment can still fail after it has settled due to a chargeback.||payment.settled|
|Customer Created||Sent every time a new customer is created.||customer.created|
|Direct Debit Request Created||Sent every time a direct debit requests is created.||ddr.created|
|Direct Debit Request Deleted||Sent every time a direct debit requests is deleted.||ddr.deleted|
|Direct Debit Request Authorised||Sent every time a direct debit requests is authorised by a customer.||ddr.authorised|
|Direct Debit Request Activated||Sent every time a direct debit requests is approved by Pay Advantage.||ddr.activated|
|Direct Debit Request Rejected||Sent every time a direct debit requests is rejected.||ddr.rejected|
|Direct Debit Request Cancelled||Sent every time a direct debit requests is cancelled.||ddr.cancelled|
|Direct Debit Request Paused||Sent every time a direct debit requests is paused.||ddr.paused|
|Direct Debit Request Resumed||Sent every time a direct debit requests is resumed.||ddr.resumed|
|Direct Debit Request Completed||Sent every time a direct debit requests is completed. This occurs when the direct debit is for a fixed amount and all installments are completed.||ddr.completed|
|Direct Debit Request Re-activated||Sent every time a direct debit requests is re-activated. This usually occurs when a payment fails after the direct debit has completed.||ddr.reactivated|
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.
Updated 18 days ago