Airwallex logo

Desktop Website Browser

Accept AlipayHK on your website by presenting your QR code to the shopper. See checkout experience as below AlipayHK - Desktop Browser

  1. The shopper chooses to pay with AlipayHK and is redirected to AlipayHK cashier
  2. The shopper uses AlipayHK App to scan the QR code and completes the payment
  3. Payment succeeds and the shopper is redirected back to the page you designated

Step 1. Initialize a payment Intent

Create a PaymentIntent object with a request_id, amount, currency and a merchant_order_id from your backend server.

https://pci-api.airwallex.com/api/v1/pa/payment_intents/create \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer your_bearer_token \
  -d '{
    "request_id": "ed11e38a-7234-11ea-aa94-7fd44ffd1b89",
    "amount": 20,
    "currency": "HKD",
    "merchant_order_id": "85d7b0e0-7235-11ea-862e-9f6aa1adfca6"
    "return_url": "https://www.airwallex.com"
  }'

Step 2. Redirect to AlipayHK Cashier to complete payment

When a shopper selects to pay with AlipayHK on their desktop browser, call the following API endpoints to get a e-wallet cashier URL, which you can redirect the shopper to AlipayHK cashier to complete payment.

  • Obtain URL from Airwallex and redirect shopper to AlipayHK cashier

Request:

https://pci-api.airwallex.com/api/v1/pa/payment_intents/{id}/confirm \
  -H 'Content-Type: application/json' \
  -H 'client-secret: Ss3thJHPE6TyI4r-8BJFlqNz1mA7DblVuN0c8GOthnchp7Sf-_JuQnuX3sqzv7_0EiTMOs2kcGopFrMoFC0w7IzPCErJ1a0P7sFnpwB6uz-H2h_6rDhhSd2tKJF-l2myVOXQV4Zou3s_OsX6thLiUKI=" \
  -d '{
    "request_id": "ed11e38a-7234-11ea-aa94-7fd44ffd1b89",
    "payment_method":
    {
      "type": "alipayhk",
      "alipayhk": {
        "flow": "webqr"
      }
    }
  }'

Response: Render the value of qrcode_url to redirect shoppers to Alipay Cashier.

{
   "next_action": {
       "type": "redirect",
       "method": "GET",
       "url": "https://render.alipay.com/p/c/jzmcoal2/hkcheck..."
   }
}
  • Wait for notification from Airwallex

Airwallex will notify you on the payment result asynchronously via the webhook API. Please refer to webhook documentation to set up your webhook accordingly. Although subscribing to different events is optional, it is recommended to at least subscribe to the ‘payment_intent.succeeded’ which indicates that the shopper has successfully paid for the order via AlipayHK.

  • Query the PaymentIntent status

You may also query the status of a payment anytime via the PaymentIntents API

GET /payment_intents/{id}