How to Integrate with LinkPay#

LinkPay API#

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#

Create LinkPay Payment Link via Portal#

Description#

Process Flow#

Portal Process Flow#

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

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.

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.

Click on Templates ID to view template details. Then, click the edit button in the upper right corner to modify template content.

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.

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.

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.

If the order type is multiple payments, there may be multiple transactions in the related transactions.

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.

If the order status is "Unpaid", you can resend email notifications to customers for payment.

When adding a new LinkPay order, you must select a store.

If templates are configured in the store, after selecting the store, you will choose the template to be used.

After selecting the template, you need to fill in the order information and provide the required user information according to the template requirements.

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.

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.

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.

You can fill in the refund amount and refund description.

Option to Integrate with LinkPay#