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 does LinkPay work

Initiate Payment Transaction on LinkPay#

This chapter describes how to initiate the payment transaction on LinkPay and how LinkPay processes transaction with EVO Cloud and PSP.

Go to LinkPay Payment Page#

Along with detailed order information via API call or Payment Link, the user web page can be redirected to LinkPay Payment Page as shown below, and the user needs to choose a payment method, either card payment or wallet payment.
image.png
Notes:
In the LinkPay interface, there are three elements that you can customize, corresponding to positions 1, 2, and 3 in the diagram above. Each position has its own method of customization
Position 1: This is the merchant's logo, which is provided by merchant, and the Acquirer can upload it for the merchant when activating the Checkout (LinkPay) feature in the EVO Cloud Portal.
Position 2: This is the merchant's name; the content here will be the same as the “Store Name” setup in EVO Cloud portal.
Position 3: This is the name of the Acquirer; the content here will be the same as the “Acquirer English Name” in EVO Cloud portal, can be defined by the Acquirer, and setup by CIL operation team.
For details about element customization, please refer to the “EVO Cloud Portal User Manual”.

Card Payment Process#

If the user wants to pay with a credit or debit card, card information is required on LinkPay Payment Page.
The screenshot is shown as below:
If you set the User Reference and Vault ID when you create a LinkPay order, the “Save card details for next time” checkbox will display on the screen.
image.png
If the user chooses “Save card details for next time” in the previous payment, then when the next payment, user will see the stored card(s) in LinkPay. They can use the card to make payments directly.
image.png
Based on the Card Schemes and acquirers set up in EVO Cloud, a 3DS authentication may be required, and the user will be redirected to a 3DS authentication page.
An example for the 3DS authentication screenshot is shown as below:
image.png
After the authentication is completed, LinkPay will go back to the following payment page with payment result.
image.png

LinkPay Payment Page Backend Process#

For bank card payment transactions, the LinkPay backend processes on both PC and Mobile are the same. Below is the process diagram for bank card payment transactions without 3DS process in LinkPay.
Below is the process diagram for bank card payment transactions with 3DS process in LinkPay.
This diagram illustrates the process of the LinkPay Payment Page; the interaction between the merchant and LinkPay is detailed in How to Integrate with LinkPay

Alipay Transaction Process#

User Journey On PC Web#

Open the LinkPay Payment Link with web browser, select 'Alipay', and then click on 'Continue'.
image.png
The browser will display a payment QR of Alipay, and customer needs to use Alipay wallet to scan the QR to complete the payment.
image.png
A success page will be displayed after the payment is completed.
image.png

User Journey On Mobile WAP#

Open the LinkPay Payment Link on mobile phone and continue to select payment method.
Select 'Alipay' to pay.
The browser will evoke Alipay APP on the users' mobile phone.
Once the user completes the payment in Alipay APP, a success page will be displayed.
image.pngimage.pngimage.pngimage.pngimage.png

LinkPay Payment Page Backend Process#

For Alipay, the LinkPay backend processes on both PC and Mobile are the same. Below is the process diagram for Alipay in LinkPay.
This diagram illustrates the process of the LinkPay Payment Page; the interaction between the merchant and LinkPay is detailed in How to Integrate with LinkPay

AlipayHK Transaction#

User Journey On PC Web#

Open the LinkPay Payment Link with web browser, select 'AlipayHK', and then click on 'Continue'.
image.png
An AlipayHK QR code will instantly pop up for the user to conduct the payment. The user needs to use AlipayHK APP to scan the QR code to conduct the payment.
image.png
A success page will be displayed after the payment is completed.
image.png

User Journey On Mobile WAP#

Open the LinkPay Payment Link on mobile phone and continue to select payment method.
Select 'AlipayHK' to pay.
The browser will redirect the user to Alipay-hosted payment page to conduct the payment.
Once the user completes the payment in Alipay page, a success page will be displayed.
image.pngimage.pngimage.pngimage.png

LinkPay Payment Page Backend Process#

For AlipayHK, the LinkPay backend processes on both PC and mobile are different. Below is the process diagram for AlipayHK on PC.
Below is the process diagram for AlipayHK on Mobile.
This diagram illustrates the process of the LinkPay Payment Page; the interaction between the merchant and LinkPay is detailed in How to Integrate with LinkPay

WeChat Pay Transaction#

User Journey On PC Web#

Open the LinkPay Payment Link with web browser, select 'WeChat Pay', and then click on 'Continue'.
image.png
A WeChat QR code will instantly pop up for the user to conduct the payment.
image.png
A success page will be displayed after the payment is completed.
image.png

User Journey On Mobile WAP#

The merchant must apply to sign up H5 payment with WeChat.
Open the LinkPay Payment Link on mobile phone, and touch 'Checkout' button to select payment method.
Select 'WeChat'.
The browser will evoke WeChat APP on the user’s mobile phone.
Once the user completes the payment in WeChat APP, a success page will be displayed.
image.pngimage.pngimage.pngimage.pngimage.png

LinkPay Payment Page Backend Process#

For WeChat Pay, the LinkPay backend processes on both PC and mobile are different. Below is the process diagram for WeChat Pay on PC.
Below is the process diagram for WeChat Pay on Mobile include below 2 payment scenarios.
a.Wechat H5 Payment: Wechat Pay user visits merchant H5 website and makes the payment in mobile browser.
b.Wechat Official Account Payment: Wechat Pay user visits merchant mobile website and makes the payment in Wechat native browser or Wechat Official Account.
This diagram illustrates the process of the LinkPay Payment Page; the interaction between the merchant and LinkPay is detailed in How to Integrate with LinkPay

Octopus Transaction#

User Journey On PC Web#

Open the LinkPay Payment Link with web browser, select 'Octopus', and then click on 'Continue'.
The browser will redirect the user to Octopus-hosted payment page to conduct the payment.
The user needs to use Octopus APP to scan the QR code or enter payment code to conduct the payment.
image.png
WEB-2.pngWAP-8_1.jpegWEB-3-2.png
A success page will be displayed after the payment is completed.
image.png

User Journey On Mobile WAP#

Open the LinkPay Payment Link on mobile phone and continue to select payment method.
Select 'Octopus' to pay.
The browser will redirect the user to Octopus-hosted payment page to conduct the payment and then select 'Tap to Pay' to invoke Octopus APP.
Once the user completes the payment in Octopus page, a success page will be displayed.
WAP-1_1.jpegWAP-2_1.jpegWAP-3_1.jpegWAP-4-EN_1.jpegWAP-6_1.jpegWAP-7_1.jpegWAP-8_1.jpegWAP-9_1.jpegWAP-10_1.jpeg

LinkPay Payment Page Backend Process#

For Octopus, the LinkPay backend processes on both PC and mobile are different.
Below is the process diagram for Octopus on PC.
Below is the process diagram for Octopus on Mobile.

One-Click Card Binding#

User Journey On PC Web#

When creating a LinkPay order, select "Single Payment" as the order type and fill in the User Reference and Vault ID in the order information.
image.png
Open the LinkPay Payment Link with web browser, enter your card number.
After entering the correct card number, the system will require you to continue entering the card's expiration date, security code, and cardholder name.
image.png
You can select to save card details for next time.
image.png
When you enter the transaction page again, you can directly use the previously saved card for payment.
image.png
At the same time, you can choose to use other cards and save them in the same way. Or delete the currently saved card information.

User Journey On Mobile Web#

Open the LinkPay Payment Link on mobile phone and continue to select payment method.
After entering the card number, you can choose to save the information for next time use, and you will be required to fill in the expiration date, security code, and other information.
After saving the information, you can choose the saved card for payment the next time you enter, and you can also delete the existing card information or use another card for payment.

LinkPay Order Multiple Payment Function#

User Journey On PC Web#

Click to jump to the LinkPay usage process

User's payment journey on PC page#

After receiving the email, the customer can click the payment link in the email to proceed with the payment operation.
image.png
In the payment interface, users need to fill in the corresponding information according to the LinkPay template requirements.
image.png
The right side displays the information entered by employees when creating the order, including product description, order number, expiration date, price, etc.
image.png
If the template requires customers to fill in billing address and delivery address, when filling in the information, the billing and delivery addresses are the same by default. If the actual situation is not the same address, customers need to click "Specify a separate delivery address" to create a delivery address to separate the two addresses.
image.png
After completing and verifying the information, you can proceed to the payment selection interface. The right side shows the customer-filled information compared to the previous interface for verification again. In this interface, you can choose the payment method needed.
image.png
After selecting the payment method and filling in the corresponding information, you can click the payment button to complete the payment.
image.png
Payment results may be: payment successful, failed, or order timeout, etc.
image.png
image.png
image.png

Standalone Card Binding#

User Journey On PC Web#

Open the LinkPay Payment Link with web browser, select 'Credit or Debit Card', and then click on 'Add Card'.
image.png
Based on the Card Schemes and acquirers set up in EVO Payment, a 3DS authentication may be required, and the user will be redirected to a 3DS authentication page. An example for the 3DS authentication screenshot is shown as below:
image.png
After the authentication is completed, LinkPay will go back to the following result page with card binding result.
image.png
Previous
LinkPay Overview
Next
Merchant Onboarding
Built with