Step 1: Get Authentication Token

All of Ezypay's API endpoints will require an Authentication token to be generated. Authentication tokens Expire after 60 mins. After that, a new authentication token will need to be obtained.

Paramater	Description
Client Id and Client Secret	This is the unique integrator client ID and integrator Secret required by the integrator to generate the Authentication Token. This is provided to the integrator.
Username and Password	This is the unique merchant account's username and password required to generate the Authentication Token for the merchant. This is provided to the Merchant upon merchant account provisioning
Merchant Id	This is the Unique identifier (GUID) that identifies the Merchant. This is provided to the Merchant upon merchant account provisioning.
Click here to obtain an Ezypay Sandbox account

Client Id:	Enter Client Id Here!
Client Secret:
Username:
Password:
Merchant Id:

Step 1 Result : Get Authentication Token:

Authentication Result:
Authentication Token TTL:
API Endpoint used to obtain Authentication token: [POST] https://identity-sandbox.ezypay.com/token
More detail on this can be found on our Devhub Guides: Generate Ezypay's Authentication Token

Step 2: Create a Customer in Ezypay

A customer and a payment method needs to be created first, after this then invoices against this customer can be created. The table below show which fields should be included in your customer creation process.

Name	Description
firstName	[Mandatory] First Name is required to create a customer.
lastName	[Mandatory] Last Name is required to create a customer.
email	[Mandatory] Customer Email is required to create a customer. This allows Ezypay to sent enabled auto notification from Ezypay.
refereceCode	[Recommended] An identifier (needs to be unique) from the integrator should be added to the referenceCode.(eg: your systems customer identification
More detail on this can be found on our Devhub Guides : Create a New Customer in Ezypay

*Customer First Name:
*Customer First Name:
*Customer Email Address:
Reference Code:

This Option will appear if PayTo is enabled in the merchant account setting.

Please select the MandateType to use for your PayTo payment method creation!
More details can be found on our DevHub Guides: Mandate Type Management

Have a look at what the information are for each of the MandateType details

Details from the MandateType Selected!!
Name:	Details:
currency:
maximumPaymentAmount:
description:

Step 2 Result: Create a Customer

Once the create customer API is triggered, a new customer Id created in Ezypay. Integrators need to store this ID so invoices can be created.

Customer Created Result:
Ezypay Customer Id
API Endpoint used to create the customer: [POST] https://api-sandbox.ezypay.com/v2/billing/customers/
Technical API Reference can be found here : Ezypay Customer Creation Reference
JSON Response:

Step 3: Create Payment Method

This is the final step in the customer creation process. There will are 2 API's which will be used here. Both of these API's are listed in the table below. Different mock card and bank accounts can used to simulate different invoice statuses.

API Name

Description

List the Customer Paid Ezypay Fees

This API retrieves the merchant configured fee's from Ezypay. This allows you to show these fee's to the customer when signing up to the Ezypay service

Ezypay Customer Paid Fees Reference guide

Load Ezypay's Hosted Payment Page

The Hosted Payment Page allows you to integrate a page directly into your software so that your customers can enter in their payment details directly into the Hosted Payment Page. The customer's details will be sent directly to our servers, where it will be validated and stored securely. (Note : All data captured must be PCI Compliant.)

Ezypay Hosted Payment Page Reference

Mock Card and Bank accounts can be used to simulate different transaction statuses for testing in the sandbox environment.

Mock Credit Card accounts :

Mock Card Payment Account Details

Mock Bank accounts:

Mock Bank Payment Account Details

Hosted Payment Page Example:

Customer paid Ezypay Fees:	Rates:

Step 3 Result : Create Payment Method:

Once the create customer API is triggered, a customer Id will be generated in Ezypay. Integrators need to completed STEP 3 before invoices can be created.

Payment Creation Result:
Ezypay Customer Id
Payment Method Token
Endpoint to PUSH the form back to Ezypay: [POST] https://vault-sandbox.ezypay.com/
Link the Customer with the Payment Method Token Endpoint: [POST] https://api-sandbox.ezypay.com/v2/billing/customers/{{customerId}}/paymentmethods
Technical API Reference can be found here: Ezypay Payment Creation Reference
More detail on this can be found on our Devhub Guides: Link Customer and Payment Token Reference
JSON Response:

Step 3a (PayTo): Mandate Status Selection

With PayTo being used as a payment method token, the customer will be required to approve their payment method selection. Do note that this is only required for testing on the Sandbox account. For production, the customer will be required to approve the mandate type through their banking providers.

Action	Description
Simulate the payment method to valid or invalid. - This will not be required in production. Approval will be managed by the customer through their banking provider.	Simulate the customer approval in the sandbox environment. PayTo payment method Validation reference guide

Select one of option below to proceed:

Choose which approval will be actioned:
Customer Ezypay Id:
Payment Method Token:

Step 3a Result : PayTo approval result:

Depending on the approval response, integrators will proceed with the invoice creation or not.

PayTo Status Result:
Ezypay Customer Id
Payment Method Token
Mandate Status
Mandate Reason
JSON Response: