Mandatory Requirements Required to Integrate with Ezypay
This document will outline the basic requirements required to integrate with Ezypay. All the listed items are required before the integration is complete.
Why are Mandatory Items Required for Integration?
Ezypay’s main business focus is to provide partners who integrate with Ezypay, 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 needs to be included into the integration process between the integrating partner and Ezypay.
The 7 mandatory items that are required for integrating partners to perform before an integration is considered as complete, includes:
- Acceptance of Ezypay's Terms and Conditions by the customers.
- Providing the correct DDR service template for bank transactions.
- Display and acceptance of all Ezypay fees charged to the customers during the customer creation process.
- 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).
- Ability to download reports (Outstanding Collections and Settlement Report)
- Failed payment handling - Retry of invoices
- 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 and agree that Ezypay will be deducting recurring payments from their accounts. It will also inform customers of what the Ezypay's terms and conditions are, especially what happens when the 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
In the table below it lists the suggested options on how this mandatory item can be achieved. An integrator can choose to use the options that Ezypay can assist in implementing or they also have the option to implement their own method of ensuring that a customer accepts Ezypay's Terms and Conditions.
| Options that Ezypay can Implement | Options that Integrators can Implement |
|---|---|
| Option 1: An integrator can use Ezypay’s hosted payment page. There will be a section under Ezypay’s hosted payment page form where the terms and conditions are displayed, and a customer acknowledges that they have accepted the terms and conditions. | Option 1: Ensure that links to Ezypay’s terms and conditions are embedded into the partner’s terms and conditions page during the customer sign-up process. This is the copy of the Ezypay's Terms and Conditions: https://www.ezypay.com/terms-policies |
| Option 2: To have Ezypay’s welcome email enabled as part of the merchant configuration. Upon successful sign-up, Ezypay will send a welcome email with the terms and conditions to the customer. | Option 2: Ensure a welcome email is sent to all customers upon sign-up. The acceptance and a copy of Ezypay’s terms and conditions must be displayed clearly in this email. |
Item 2: Providing the Correct DDR Template for Bank Transactions
A Direct Debit Request (DDR) template should be used for customers who have nominated for their payments to be deducted from their bank account.. The DDR template needs to be region specific (Australia or New Zealand) that lists the specific Terms & Conditions, fees and charges, relevant to that region.
It is important that the customers are aware of Ezypay's Direct Debit service details, so that they understand that Ezypay will be deducting payments from their bank account. This is to avoid any charge back claims that the customer may request with their bank.
Options to Achieve this Mandatory Item
In the table below it lists the suggested options on how this mandatory item can be achieved. An integrator can choose to use the option that Ezypay can assist in implementing or they also have the option to implement their own method of ensuring that customers are presented with the correct DDR template during customer sign up.
| Options that Ezypay can Implement | Options that Integrators can Implement |
|---|---|
| An integrator can choose to use the DDR templates that Ezypay has for both regions (Australia and New Zealand). | An integrator can provide a copy of their own DDR to the customer (for both regions Australia and New Zealand), If an integrator opts for this option they need to ensure that the DDR template complies with the Ezypay requirements. |
Item 3: Display and Acceptance of Fees Charged to the Customers by Ezypay when the Customer is Created
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 for the Ezypay fees, then the rate of what the fees are will need to 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
In the table below it lists the suggested options on how this mandatory item can be achieved. An integrator can choose to use the option that Ezypay can assist in implementing or they also have the option to implement their own method of ensuring that Ezypay fees are displayed clearly to a customer during the sign up process.
| Option that Ezypay can Implement | Options that Integrators can Implement |
|---|---|
| Ezypay has an API for integrators to use where it will display customer paid fees through that API. Please refer to the documentation below for an explanation on Ezypay fees: https://developer.ezypay.com/docs/retrieve-ezypay-customer-paid-fees | Option 1: To add the visibility of the fees that will be charged to the customer sign-up process. This will need to be displayed to a when a customer selects which payment method they wish to have set up. |
| Option 2: Ensure a welcome email is sent to all customers upon sign-up. The fees that will be charged must be listed clearly in the email. |
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 4: 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 and invoice has been attempted.
This is to ensure that a customer and the merchant has a clear break down of the Ezypay fees, that will be charged in addition to their agreed invoice amount.
As mentioned above in mandatory item 2, there are Ezypay fees that might be deducted with the invoices from the customers if a merchant has elected for these to be paid by their customer
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
In the table below it lists the suggested options on how this mandatory item can be achieved. Currently for this mandatory item, Ezypay can only provide an API displaying the fees charged after and invoice has created.
| Option that Ezypay can Implement | Options that Integrators can Implement |
|---|---|
| Ezypay can only assist in implementing the Ezypay fees that have been charged only after the invoice has been attempted. This can be achieved through the Ezypay API that was used in Mandatory Item 2. | Partners need to add a breakdown of any customer paid Ezypay fees against every invoice, so that this can be visible to merchants and their customers through the user interface of their software. |
Item 5: Ability to Download Reports
It is important to communicate to the merchants on what transactions have occurred against the their account. Ezypay has 2 types of reports available that can be used by merchants for reconciliation. These reports are:
1. Settlement Report
This report provides the merchants with a summary of their settlement period. It will provide a break down 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
In the table below it lists the suggested options on how this mandatory item can be achieved. An integrator can choose to use the options that Ezypay can assist in implementing or they also have the option to implement their own method of ensuring that Ezypay fees are displayed clearly to a customer during the sign up process.
| Options that Ezypay can Implement | Options that Integrators can Implement |
|---|---|
| Option 1: Use the API to manually retrieve: - Outstanding Collections Report. - A link to download the Settlement Report. Depending on if it is a summary report or a full transaction report. | Option 1: To allow merchants to access and download the Ezypay reports through the user interface of the software. |
| Option 2: To send an automated email of the report to the merchants. This option is only available for settlement reports. This must be configured during the merchant on-boarding process **Note:** The Outstanding Collections Report currently does not have the automated email option. | Option 2: To send automated emails to the merchants based on information extracted from Ezypay |
API Reference Guides to the Settlement Report and Outstanding Collections Report
Please refer to the API documentation below for details on the settlement reports
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 needs to 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 even just to cancel the failed payment as they no longer wish to collect it from the customer.
Integrators would need to provide a detailed process on how a merchant would handle a failed payment, as a basic requirement during the integration process with Ezypay.
Options to Achieve this Mandatory Item
In the table below it lists the suggested options on how this mandatory item can be achieved. An integrator can choose to use the options that Ezypay can assist in implementing or an integrator can implement their own method on how to handle a payment when it fails.
| Options that Ezypay can Implement | Options that Integrators can Implement |
|---|---|
| Option 1: Pay Now option: This is configured through Ezypay, where an email will be sent to the customer as soon as a payment has failed. The amount of the failed transaction and all the fees incurred will be displayed in that email. With this option, the customer will have the ability to try a new payment method to recover that failed payment. | Option 1: Manual retry option on payments that failed. This is were the merchant can retry the failed invoice, when the customer is ready to pay for the debit. There is no specified time on when the failed invoice will be attempted again. This will be initiated by the user. |
| Option 2: Retry After X amount of days: Ezypay will automatically rebill the failed payment X days after receiving the failed payment notice from our payment providers. Changes to the failed invoice can be done before that attempted date. This will need to be configured during the Merchant On-boarding process. | Option 2: Write-off failed payment: The failed payment will be cancelled or removed. Ezypay will acknowledge that the failed payment is no longer required for collection. The outstanding invoice can be added onto the next upcoming invoices or collected outside of Ezypay. NOTE:Any customer paid Ezypay fees attached to this invoice will be deducted from the merchant’s upcoming settlement. |
| Option 3: Retry After X amount of days To set up an automatic rebill to reattempt the failed payment X days after receiving the failed payment notice from Ezypay. |
Item 7: Refund of Payment
When a payment has been collected successfully, a merchant needs to 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
In the table below it lists the suggested options on how this mandatory item can be achieved. An integrator can choose to use the options that Ezypay can assist in implementing or they also have the option to implement their own method of allowing merchants to perform refunds to their customers.
| Option that Ezypay can Implement | Option that Integrators can Implement |
|---|---|
| Ezypay has an API feature to request for the invoice to be refunded. Please refer to the documentation below for the refund API: https://developer.ezypay.com/reference#refund-an-invoice | Integrators can handle this on their end, whereby the refunds are processed over the counter between the merchant and customer. |
NOTE:
Only full refund amounts can be processed. Currently Ezypay does not handle partial refunds.
Updated about 3 years ago
For a step by step guide of the integration: