Mandatory Items Required to Integrate with Ezypay

Why are Mandatory Items Required for Integration?

Ezypay’s main business focus is to provide our integrated partners with an end-to-end solution towards the collection of subscription payments for their merchants. In order to achieve the best possible collection rate and experience for their customers, 7 mandatory items have been identified that must be included in the integration process between the integrating partner and Ezypay.

The mandatory items required from integrating partners before an integration is considered complete, include:

1. Customer Creation : Acceptance of Ezypay's Terms and Conditions by the customers.
2. Customer Creation : Display and acceptance of all Ezypay fees charged to the customers during the customer creation process.
3. Customer Creation : Integrate all payment methods that are available for the region ( ie. Bank, PayTo, Master, Visa and Amex)
4. Invoice Management : Display the invoice status (and failure reason) and the breakdown of Ezypay fees charged for each invoice (before and after an invoice has been attempted).
5. Reporting : Ability to download reports (Outstanding Collections and Settlement Report).
6. Failed payment handling : Retry of invoices.
7. Refund and Chargeback Handling process : Refund of payment.

These items are required to ensure that the business and their customers are compliant and informed.

The 7 Mandatory Items

Item 1: Acceptance of Ezypay's Terms and Conditions to Customers

It is important to ensure that Ezypay's Terms and Conditions are presented to customers when they sign up with a merchant. This is to ensure that customers are aware of, and agree to, Ezypay deducting recurring payments from their accounts. It also informs customers what the Ezypay's Terms and Conditions are, especially what happens if a deducted payment fails.

The Ezypay Terms and Conditions should be displayed to the customers during the sign up process. Ideally when the payment method is created or entered. A customer must accept and agree to Ezypay's Terms and Conditions during the customer sign up process.

📘

Note:

• A Terms and Conditions acceptance field is required to be flagged in the "create" customer API when a customer has accepted the Terms and Conditions.

Options to Achieve this Mandatory Item
The table below lists suggested options on how to achieve this mandatory item. An integrator may choose to use the options below, with Ezypay's assistance in implementing, or they may choose to implement their own method to ensure a customer accepts Ezypay's Terms and Conditions.

Item 2: Customer Creation: Display and Acceptance of Fees Charged to the Customers

There are 3 types of fees (Load fee, Transaction fee and Failed Payment fee) that Ezypay can charge with the deducted invoices from the customers. These fees can be elected to be paid by the merchant or the customer. If the merchant has elected for the customer to pay the Ezypay fees, then the rate of those fees must be displayed clearly against the customer's record. These will be relevant to mandatory item 3 and item 4.

As part of the customer sign up process, all customer paid Ezypay fees should be displayed and accepted by customers when they select the payment method they wish to sign-up with (e.g. Bank, Visa, Mastercard, etc). This is in relation to the transaction fees, and only if the merchant has elected for this fee type to be paid by the customer. This is to ensure that customers know what fees are included in their payments when the deduction takes place.

Options to Achieve this Mandatory Item
The table below lists suggested options on how to achieve this mandatory item. An integrator may choose to use the options below, with Ezypay's assistance in implementing, or they may choose to implement their own method to ensure Ezypay fees are displayed clearly to a customer during the sign up process.

📘

Note:

For integrators on the subscription model:
Ensure an email for every new subscription sign-up is sent to the customer, so that the customer is aware of the charges

Item 3: Customer Creation: Integrate all payment methods

Ezypay offers the ability to collect payments through different payment methods. These include Bank, PayTo, Mastercard, Visa and Amex. Different regions will have different payment methods available. It is important to ensure that when you integrate with Ezypay that you have included all the payment method options that are available for the specific regions. This will give merchants and their customers more options on how they want payments to be deducted.

Please refer to the guide of supported payment methods that we have available per region:

https://developer.ezypay.com/docs/our-supported-payment-methods

Item 4: Invoice Management: Display the Invoice Status

As a mandatory requirement, Ezypay requests that status of an invoice (including failure reason) and the breakdown of Ezypay fees charged for each invoice should be displayed clearly. This should be shown before and after an invoice has been attempted.

This ensures that both the customer and the merchant have a clear breakdown of the Ezypay fees charged, in addition to their agreed invoice amount.

The status of the invoice, including their failed payment reason needs to be visible to the merchants.

The important webhook that is needed is the “invoice_past_due” – also see failed payment handling section below for more details

Note:

📘

These fees could include:

• Ezypay Load Fees
• Ezypay Transaction Fees
• Ezypay Failed Payment Fees
• Other additional fees

** The above fees will be dependent on the merchant's set up.

More information on the type of Ezypay fees and how they are applied to the invoice can be found here:
https://developer.ezypay.com/docs/ezypay-fees-1

Options to Achieve this Mandatory Item
The table below lists suggested options on how to achieve this mandatory item. Currently for this item, Ezypay can only provide an API displaying the fees charged after an invoice has created.

Item 5: Reporting: Ability to Download Reports

It is important to communicate to merchants what transactions have occurred against their account. Ezypay has 2 reports available that can be used by merchants to assist with reconciliation. These reports are:

1. Settlement Report
This report provides merchants with a summary of their settlement period. It provides a breakdown of the customers billed, customers who have failed payments, Ezypay fees, etc.

2. Outstanding Collections Report
This reports provides merchants a summary of the customers who have outstanding payments to date.

Options to Achieve this Mandatory Item
The table below lists suggested options on how to achieve this mandatory item. An integrator may choose to use the options below, with Ezypay's assistance in implementing, or they may choose to implement their own method to ensure merchants have visibility of the transactions against their account.

📘

API Reference Guides to the Settlement Report and Outstanding Collections Report

Please refer to the API documentation below for details on the settlement reports

• Summary List of Settlements link

• Full Settlement Transaction Report link

Please refer to the API documentation below for details on the Outstanding Collections Report:

• Generate Outstanding Collections Report link

Item 6: Failed Payment Handling: Retry of Invoices

When a customer fails a payment, a merchant must have the ability to choose how they want to handle and recover that failed payment. This could be a retry of the failed invoice, or to just cancel the failed payment as they no longer wish to collect it from the customer.

As a basic requirement during the Ezypay integration process, integrators are asked to provide a detailed process on how merchants would handle failed payments.

Options to Achieve this Mandatory Item
The table below lists suggested options on how to achieve this mandatory item. An integrator may choose to use the options below, with Ezypay's assistance in implementing, or they may choose to implement their own method on how to handle a payment when it fails.

Item 7: Refund and Chargeback Handling :Refund of Payment

When a payment has been collected successfully, a merchant must have the ability to refund their customers upon request, based on what has been negotiated between the merchant and the customer. Therefore, integrators will need to provide the capability for merchants to handle refunds themselves through the integrator's software.

Options to Achieve this Mandatory Item
The table below lists suggested options on how to achieve this mandatory item. An integrator may choose to use the options below, with Ezypay's assistance in implementing, or they may choose to implement their own method of allowing merchants to perform refunds to their customers.