Ezypay provides APIs for integrators to manage their customers. Here's an overview of the available customer management functions:

Update customer

Use the update customer API to update Ezypay when there is a change in customer information. Changes in mobile number and email address must be communicated to Ezypay in order for Ezypay to contact the customer.

Customer transfer

This process facilitates the transfer of customers between merchants within the Ezypay platform while maintaining customer data and avoiding the need for re-entry of payment information.

🚧
Important

Integrator Scope: Transfers are permitted subjected to proper transfer management.

Customer Consent: The customer must agree on the transfer and reuse of their payment token with a new merchant.

Best Practice Guide:

🚧
Best Practice for handling Customer Transfer:
Customer Transfer request:
Customer transfer requests must be initiated directly via the Merchant Portal. This process should be fully self-service and does not require manual intervention. An online transfer form should be available within the Merchant Portal, where the transfer option can be selected and submitted accordingly.
Payment Method Management The system supports the recovery of invalid payment methods in the new club. If a transferred payment method is invalid, customers will be provided with the option to submit updated payment details within the new club to ensure continuity of billing.
Supported Payment Method Types
Supported payment method types vary by region and are outlined in the referenced documentation. For cross-region transfers we only support:

Card payments (Visa and Mastercard)

The following payment methods are not supported for cross-region transfers:

Bank account

PayTo

GCash

NOTE: Please note that payment tokens cannot be transferred to or from South Korean regions due to regulatory and processing limitations.

Steps for customer transfer:

Identify Ezypay's customer number
Use the Retrieve Customer API to access the customer’s unique customer number field (formatted as EZYxxxxxx).

{
  "id": "55220ffc-bc5a-4f50-adaf-fa58c061ebd1",
  "number": "EZY213000",
  ...
}

Create new customer

Use the Create Customer API to create a new customer under the new merchant profile. Include the number obtained in Step 1 as the customerNumber parameter in the request. The new profile receives a unique id but retains the original number.

{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "[email protected]",
  "referenceCode": "GYM5678",
  "mobilePhone": "+6143215678",
  "customerNumber": "EZY213000"
}

{
  "id": "269e3f59-c01c-4a42-8a09-02908fa4ce31",
  "number": "EZY213000",
  "referenceCode": "GYM5678",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "[email protected]",
  "companyName": null,
  "mobilePhone": +6143215678,
  "homePhone": null,
  "gender": null,
  "dateOfBirth": null,
  "createdOn": "2024-03-10T20:10:54.895",
  "address": null,
  "metadata": null
}

Retrieve payment methods tokens

Use the List Payment methods API to access payment tokens linked to the existing customer. Skip this step if the payment tokens are already available.

Link tokens to new customer ID

Use the Create Payment Method API to link the payment tokens with the new customer ID. For multiple payment methods, repeat this step as needed.

Upon completing these steps, the customer is fully transferred to the new merchant and ready for billing.

📘
Note
Ezypay treats the new profile as independent; actions on one profile do not impact the other. The original customer profile remains active and billable.
Do not transfer GCash and PayTo payment tokens to the new profile, as they involve strong authentication measures prohibiting use with different merchants.