Payment Method Management
Utilising the right payment method at the right time is an essential tactic for improving payment collection rates. Ensuring customers can easily identify and change the payment method is crucial, especially when multiple payment methods are stored and used.
Any billing attempt using an invalid payment method will fail. Additionally, if you try to create invoice or subscription with an invalid payment method, the API will return an error and no invoice or subscription is created. Therefore, addressing invalid payment methods promptly is critical to maintaining a high collection rate. Ezypay helps identify invalid payment methods through the following:
payment_method_invalid
webhook event.paymentMethodInvalid
field in Ezypay's invoice payload
When an invalid payment method is detected, inform the customer immediately. They must provide a new payment method and replace the existing one before billing can continue. You will be able to retry the invoice once this is done.
Warning
Ezypay's auto rebill feature will stop once a payment method is identified as invalid.
Add new payment method
Ezypay supports multiple payment method for single customer. There are 3 possible ways for customer to add new payment method:
- Using HPP. Refer Payment Method Collection for more information.
- Using Checkout. Refer to Checkout Guide for more information.
- Using Pay Now. Refer to Pay Now Guide for more information.
View saved payment method
Customers should have the ability to view their saved payment methods and easily identify which one is currently in use. Due to the sensitivity of full payment details, Ezypay provides truncated information for most payment methods, except for PayTo and wallet payments. For more information on the payment methods data provided by the APIs, refer to the Payment Methods Payload.
Table below outlines the minimum expectations for displaying a payment method:
Payment method type | Minimum information to display |
---|---|
CARD | card type, last 4 digit of card number and expiry date |
BANK | bank number and last 4 digit of account number |
PAYTO | Dependent on PayTo account type:BBAN : BSB number and bank account numberALIA : Either phone number or email address |
WALLET | Wallet type and mobile number. |
Delete saved payment method
Use the Delete Payment Method API when customer choose to delete a saved payment method from your platform. Any payment method deleted will have its PAN data removed from Ezypay's Vault Environment.
Replace payment method
Customers should have the option to replace their payment method in the following scenarios:
- The current payment method has become invalid, and a new one is required.
- The customer prefers to use a different payment method for billing.
Use Replace Payment Method API to replace an old payment method with a new one and set it as primary. This action will update all invoices and subscriptions associated with the old payment method to the new one.
Set default payment method
Customers should have the ability to select their default payment method. Allowing them to choose the payment method reduces the likelihood of failed payments and improves collection rates.
Ezypay treats the primary payment method as the default, automatically using it for billing if none is specified. Use update the payment method API to change the primary payment method. Unlike replace payment method, this will not update invoices and subscriptions associated with the old payment method. You can check the current primary payment method stored by Ezypay using retrieve the primary payment method API.
Updated about 1 month ago