List of Webhook Events
Ezypay provides the following events and subscribed Webhooks can be configured to send notifications when these events happen:
Event | Occurs when... |
---|---|
customer_create | Event when a new customer is created. |
customer_update | Event when a customer's details are updated. |
invoice_created | Event after an invoice is created. |
invoice_past_due | Event when an invoice status has changed to past_due because the invoice due date has passed but the invoice has not been paid. Can occur because of a failed transaction or no transaction was attempted. |
invoice_paid | Event when an invoice status has changed to paid because of a successful payment transaction. |
invoice_batch_created | Event when a batch of ad-hoc invoices to bill one or more customers on an on-demand basis gets created. |
invoice_batch_processing | Event when a batch of ad-hoc invoices to bill one or more customers on an on-demand basis is being processed. |
invoice_batch_success | Event when the status of a batch of ad-hoc invoices to bill one or more customers on an on-demand basis changes to success. |
invoice_batch_invoice_failed | Event when the status of a batch of ad-hoc invoices to bill one or more customers on an on-demand basis changes to failed. |
subscription_create | Event when a new subscription is created. |
subscription_cancel | Event when a subscription is cancelled. |
subscription_activate | Event when a subscription is activated. |
subscription_completed | Event when a subscription completes. |
subscription_reactivate | Event when a customer's subscription is reactivated. A customer's subscription can become deactivated because of past due invoices. When all invoices are resolved, the subscription will automatically reactivate. |
subscription_stopped | Event when a subscription's billing schedule becomes inactive and billing has stopped. |
payment_method_invalid | Event when a customer's payment method becomes invalid. This event is only thrown when a valid payment method becomes invalid. If a payment method is invalid upon creation, no webhook event is triggered. |
payment_method_valid | Event when a customer's payment method becomes valid. This event is only thrown when a customer approves their PayTo payment method (which sets the payment method to valid), as PayTo payment methods are invalid by default. |
payment_method_linked | Event when a payment method gets linked to a customer. |
payment_method_replaced | Event when a customer's payment method gets replaced by another. |
payment_method_changed | Event when a customer's primary payment method gets changed to another. |
credit_note_created | Event when a credit note is created. This event is triggered when a merchant moves funds to a customer usually as a refund or a dispute. |
credit_note_paid | Event when a credit note is successfully paid. Credit note status changed to paid. |
credit_note_failed | Event when a credit note transaction has failed. Credit note status changed to failed. |
partner_invoice_created | Event after a partner invoice is created. |
partner_invoice_paid | Event when a partner invoice status has changed to paid because of a successful payment. |
partner_invoice_past_due | Event when a partner invoice status has changed to past_due because the invoice due date has passed but the invoice has not been paid. |
transaction_settled | Event when money from an invoice is settled to the merchant. |
Updated 3 months ago