Ezypay offers integrators two primary ways for payment recovery if the payment fails:

1. Utilising Ezypay's API suite.
2. Relying on Ezypay's automated recovery system.

Pre-requisites

Integrate with invoice webhook

Integrate with Ezypay's webhook notifications to track payment outcomes, including failures and recoveries

1. invoice_past_due - Triggered when a payment fails, marking the starting point of any recovery process.
2. invoice_paid - Triggered upon successful payment recovery.

Identify invalid payment methods

For payments that fail due to an invalid payment method, replace the payment method before proceeding with recovery. Use the invoice_past_due webhook to identify such cases through the data.paymentMethodInvalid flag.

Get started

Ezypay automated payment recovery

Ezypay provides the following automated recovery options when a payment fails:

Failed payment email

An email is sent to the customer for overdue payment, containing:

1. Reasons for payment failure.
2. Outstanding amount
3. Payment method used.

This email is sent by help@ezypay.com and carries Ezypay branding.

Failed payment email with Pay Now

An enhanced version of the failed payment email includes a Pay Now link, which allows customers to clear their outstanding amount immediately. Refer to the Pay Now Guide for more information.

👍

Sample

Please refer to the Sample Failed Payment Email for the 'Failed Payment' email sent by Ezypay.

Automatic retry

Ezypay will automatically reattempt to recover the payment from the customer with the original payment method. This function comes with a configurable schedule and frequency for the retries.

📘

Note:

Options above can be configured on and off independently during merchant onboarding.

Custom recovery via Ezypay API Suite

If Ezypay's automated services do not meet your requirements, you can build a custom recovery process in your platform using the following tools:

Retry API

Use the Retry Invoice API to reattempt payment collection on failed invoices. Provide the invoiceId of the failed invoice in the request body. Use invoice_past_due and invoice_paid webhook to monitor the outcomes of the retries.

This is useful for implementing a scheduler for automated retries or a manual "Retry Payment" button on your platform.

Utilising the Pay Now link

The invoice_past_due webhook provides a Pay Now link in the data.payNowUrl field. You can include this link on your platform or any customer notification, enabling customers to pay their outstanding balance conveniently. Refer to the Pay Now Guide for more information

Best practice

Notify customer on failed payments

Ensure customers are informed when a payment fails. Notifications should include the following details: