1. Guide
Linkpay API
  • Guide
    • LinkPay Overview
    • How does LinkPay work
    • Merchant Onboarding
    • How to Integrate with LinkPay
    • Signature and Message Header
    • Customization Service
    • Payment methods list
    • Payment Method Variant list
    • Result Code
    • Version Record
    • Agent Toolkit Overview
    • Agent Toolkit Quick Start
  • API
    • LinkPay
      • Result Code
      • LinkPay
    • Retrieve LinkPay
      • Result Code
      • Retrieve LinkPay
    • Refund
      • Result Code
      • Refund
    • Retrieve LinkPay Refund
      • Result Code
      • Retrieve LinkPay Refund
    • Notification
      • Result Code
      • LinkPay Notification
      • Refund Notification
      • Canel Notification
    • Cancel or Refund
      • Cancel or Refund
  1. Guide

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:
image.png
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 Retreive LinkPay in this document.

Specify the Language of LinkPay Payment Page#

After obtaining the LinkPay Payment Link (URL) via the LinkPay API, the merchant can append a lang query parameter to the URL to specify the default display language of the LinkPay Payment Page.
Parameter name: lang
Usage: append it to the Payment Link (URL) returned by the LinkPay API as a query parameter.
For example, appending the parameter to display the page in Simplified Chinese:
https://hkg-counter.everonet.com/linkpay/b5e317070048425aa78d999782b0e0d0?lang=zh-CN
Notes:
The parameter value is case-insensitive and will be normalized to a supported language (see the "Normalized" column below). For example, both zh-cn and zh are normalized to zh-CN.
If the parameter is not provided, or the provided value is not in the supported list, the page will fall back to English (en-US).

Supported Languages#

Parameter ValueNormalizedLanguage
en-US / enen-USEnglish
zh-CN / zh-cn / zhzh-CNSimplified Chinese
zh-TW / zh-twzh-TWTraditional Chinese
jajaJapanese
th / th-THthThai
ko-KR / koko-KRKorean
lo / lo-LAlo-LALao
fr / fr-FRfr-FRFrench
es / es-ES / es-419es-419Spanish (Latin America)
pt / pt-PT / pt-419pt-419Portuguese (Latin America)
ruruRussian
swswSwahili
Any other valueen-USEnglish (fallback)

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#

Enter the everonet platform homepage, under the LinkPay menu there are two modules: LinkPay Orders and LinkPay Templates
image.png

LinkPay Templates#

Under the LinkPay Templates module, you can see LinkPay payment templates, where you can perform filtering, searching, and adding new template operations at the top.
image.png
On the right side of the template, you can perform disable, enable, delete operations. The delete operation can only be performed when the template is in disabled status.
image.png
Click on Templates ID to view template details. Then, click the edit button in the upper right corner to modify template content.
image.png
In the add new interface, we need to fill in template information, including name, scope, type, and who will fill in the user-related information.
image.png
After completing and saving the template information, you can select this template when creating LinkPay orders for this store.

LinkPay Orders#

In the LinkPay Order list, you can export orders to CSV or Excel.
image.png
Click on the order ID to view order details. The order status is shown in the upper right corner. If the status is "Paid", you can view related transactions below.
image.png
If the order type is multiple payments, there may be multiple transactions in the related transactions.
20250626-141414.png
When viewing transaction details in case of payment failure, you can see the payment failure return code, and you can query the failure reason through the return code.
image.png
If the order status is "Unpaid", you can resend email notifications to customers for payment.
image.png
When adding a new LinkPay order, you must select a store.
image.png
If templates are configured in the store, after selecting the store, you will choose the template to be used.
image.png
After selecting the template, you need to fill in the order information and provide the required user information according to the template requirements.
image.png
According to LinkPay template requirements, if customer information needs to be filled by employees, this field is mandatory when creating an order; if it doesn't need to be filled or is to be filled by customers, this field will not be displayed; if it's optional for employees, then this field is not mandatory.
image.png
20250625-101107.png
image.png
At the bottom of the order creation page, after entering the user's name and email, you can choose to send an order creation reminder email. This email will remind the user to click the link in the email to make the payment.
image.png
When creating an order, after entering the customer's name, email, and selecting email notification, the customer will receive a payment reminder email. If email notification is not selected, the customer will not receive this email.

LinkPay Refund#

In transaction details interface, you can perform refund operations in the upper right corner.
image.png
You can fill in the refund amount and refund description.
image.png

Option to Integrate with LinkPay#

With the selected API, merchants can integrate with LinkPay in different ways.
Option 1Option 2Option 3Option 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.
Previous
Merchant Onboarding
Next
Signature and Message Header
Built with