How to Integrate with Linkpay
There are two options for merchants to initiate an online payment process:
- Option 1: Merchant can integrate with LinkPay via API defined in this document to get the LinkPay Payment Link (URL) for user to access LinkPay Payment Page for payment.
- Option 2: Merchant can create LinkPay Payment Link manually on EVO Cloud Portal and send over to the user to access LinkPay Payment Page for payment.
Linkpay API
The merchant can integrate with LinkPay through LinkPay API, then user can initiate the transaction via merchant’s Order Page, then process the payment by redirecting to LinkPay Payment Page. A basic processing is as below
Initiate Linkpay
A sample merchant Order Page to initiate LinkPay is as below:
User confirms the transaction, and clicks the button of Check Out, to initiate LinkPay Payment Page for the payment.
Process Flow
The process flow for LinkPay API call is as shown below, between the merchant Order Page and LinkPay:
Notes:
- Step 8 is applicable only if the merchant sends the returnURL while calling the LinkPay API (step 3). After the payment has been processed successfully, LinkPay will redirect to the merchant page within 5 seconds. As well, LinkPay will include the URL in the response as shown below:
https://www.merchantweb.com/?merchantOrderID=123123123123&result=success - Step 9 is applicable only if the merchant sends the webhook while calling the LinkPay API (step 3). After the payment has been proceeded successfully, EVO Cloud will send the notification to the webhook URL.
- Steps 10 and 11 are applicable only when the merchant wants to retrieve the status and detail of the payment transaction. For detailed API definition, please refer to Retrieve LinkPay in this document.
Create LinkPay Payment Link via Portal
Description
The merchant can also create Payment Link via EVO Cloud Portal, which can enable the merchant and user to complete online payment without any merchant system and technology involved. Once received the transaction order from the user, the merchant can then log on EVO Cloud Portal with ID and Password assigned by EVO Cloud to initiate the payment transaction. After the transaction information is input in EVO Cloud Portal, with an email address or phone number entered, EVO Cloud can send an email or an SMS to the user with the Payment Link EVO Cloud generated. After receiving the email or SMS, the user can click the Payment Link to go to LinkPay Payment Page to complete the payment. The merchant can access EVO Cloud Portal to inquiry the transaction status and detail, and receive the related transaction report from EVO Cloud.
Process Flow
A basic process flow for LinkPay initiated via EVO Cloud Portal is as shown below, among the merchant, user, EVO Cloud Portal and LinkPay:
Portal Process Flow
The screenshots below show the LinkPay service on EVO Cloud for merchant staff to complete the operation.
- Find the LinkPay service on EVO Cloud Portal under the acquirer ID and assigned merchant ID.
- Create an order based on the transaction information that the user has sent and confirmed. The order can be sent to user’s email box or mobile phone after being created successfully.
- Obtain the Payment Link in order detail page which can be sent to the user for the payment.
- If user does not receive the Payment Link, the merchant can resend the Payment Link to the user in order detail page.
- The merchant can redefine the email and cell phone number while resending the order to user.
- The content of email notification for Payment Link can be customized.
- The content of SMS notification for Payment Link can be customized.
Option to Integrate with LinkPay
With the selected API, merchants can integrate with LinkPay in different ways.
| Option 1 | Option 2 | Option 3 | Option 4 | |
|---|---|---|---|---|
| Selected API(s) | - N/A | - LinkPay API | - LinkPay API - Retrieve LinkPay API - Notification | - LinkPay API - Retrieve LinkPay API - Notification - Refund API |
| How to create Payment order | - EVO Cloud Portal | - API "LinkPay" | - API "LinkPay" | - API "LinkPay" |
| How to get the payment result | - EVO Cloud Portal | - Notification - EVO Cloud Portal | - Notification - Retrieve LinkPay API - EVO Cloud Portal | - Notification - Retrieve LinkPay API - EVO Cloud Portal |
| How to refund | - EVO Cloud Portal | - EVO Cloud Portal | - EVO Cloud Portal | - Refund API - EVO Cloud Portal |
- If the merchant wants to receive the payment result by a notification, the merchant needs to send the webhook address when creating the LinkPay Order and requesting the LinkPay Payment Link.
- The merchant can obtain the payment result and related transaction information using either Retrieve LinkPay API or notification.
