5.8 ALIPAY_HK
Founded in 2017, AlipayHK is the first wallet in Hong Kong to provide traffic QR code payment. It supports scanning the QR code in Hong Kong subways, buses, and minibuses. It can also be used in a variety of local life scenarios, including receiving government coupons, shopping, catering, utility payments, and transfers. Alipay (Hong Kong) is the most popular wallet in the Hong Kong market. It provides convenient payment both online and offline. The online merchants that support payment via AlipayHK include Taobao, Uniqlo, App Store, and Google Play. The offline stores supported include 711, McDonald's, and Watsons.
| Scenario | Category | Payment method | Payment product | Integration type | Authentication | Redirect Type | Code Type | Pre-auth | Partial Refund | Cancellation supported |
|---|---|---|---|---|---|---|---|---|---|---|
| ONLINE | Ewallet | ALIPAY_HK | CASHIER_PAYMENT | API | - | In-app | Order code | - | YES | YES |
| OFFLINE | Ewallet | ALIPAY_HK | ORDER_CODE | API, POS | - | - | Order code | - | YES | YES |
| OFFLINE | Ewallet | ALIPAY_HK | PAYMENT_CODE | API, POS | - | - | Payment code | - | YES | YES |
| OFFLINE | Ewallet | ALIPAY_HK | ENTRY_CODE | EMVCO_QR | - | - | Static code | - | YES | YES |
| Payment Product | Description |
|---|---|
| CASHIER_PAYMENT | Payment product. Use this product to get the cashier page address. After getting the cashier page address, you can redirect the user to the cashier page to make a payment or display the online order code for the user to scan. |
| ORDER_CODE | Merchant-Presented Mode Payment product. One code value can only be used for one transaction. For example, the order code displayed on the merchant's terminal screen or printed on the cashier's receipt. After the user scans the code, the user usually does not need to enter the transaction amount to initiate the payment. |
| PAYMENT_CODE | User-Presented Mode Payment product. The merchant uses a code scanning device to scan the payment code and complete the deduction. |
| ENTRY_CODE | Merchant-Presented Mode Payment product. With the Entry Code Payment product, users can scan the entry code generated by the merchant and enter the payment amount to complete the payment. Merchants do not need to apply an updated QR code or purchase any equipment for collecting payment if merchants join the UPAS network. |
Experience and integration process
| Capabilities | APIs | Description |
|---|---|---|
| Initiate a payment | PAY | |
| Refund a payment | REFUND | |
| Cancel a payment | CANCEL | Only a full cancellation is allowed. The cancellation period: Before 23:59:59 within the payment date. |
| Inquiry transaction result | DETAIL | |
| Notify transaction result | NOTIFICATION |
Initiate a payment
| Field | Description | Required |
|---|---|---|
paymentMethod |
Must be "ALIPAY_HK" |
M |
product |
For CASHIER_PAYMENT, it must be "CASHIER_PAYMENT"; |
M |
expireAt |
The format is "yyyy-mm-dd hh:mm:ss", and it must be less than 72 hours after the payment request is sent. |
C |
payCodeValue |
It's required when the product is "PAYMENT_CODE" |
C |
goods.description |
It's required when paymentMethod is ALIPAY_HK |
M |
riskData.Device.os |
It's required when the product is in "CASHIER_PAYMENT", "ORDER_CODE", "PAYMENT_CODE" |
M |
Handle the payment result To complete the payment:
- CASHIER_PAYMENT
- present the QR code image(payAction, "type": "QRCODE", "redirectUrl") to the shopper for scanning.
- Or redirect shopper(payAction, "type": "REDIRECT", "Url") to open an app when the target app is installed.
- Use the data.status from the PAY response to present the payment result to your shopper. You can also wait the NOTIFICATION or submit a DETAIL request for the payment result.
- ORDER_CODE
- Present the QR code image(payAction, "type": "QRCODE", "redirectUrl") to the shopper for scanning.
- After the shopper completes the payment, wait the NOTIFICATION or submit a DETAIL request for the payment result.
- PAYMENT_CODE
- Use the data.status from the PAY response to present the payment result to your shopper. You can also wait the NOTIFICATION or submit a DETAIL request for the payment result.
- ENTRY_CODE
- After the shopper completes the payment, wait the NOTIFICATION for the payment result.
Updated 6 days ago