Log inGet started
Airwallex logo
Home
Online Payments
Treasury
Transactional FX
Payouts
Issuing
Scale
Open Banking
Developer Tools
API Reference
Home
Online Payments
Overview
Starting with paymentsAirwallex platform overviewOnline payments modelPricing model
Payment Methods
OverviewGlobalEU & UKAPAC
APAC RegionalAustraliaChinaHong Kong
AlipayHK
Desktop Website Browser
Mobile AppMobile Website Browser
IndonesiaJapanKoreaMalaysiaPhilippinesSingaporeThailandTaiwan
US & LATAM

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.

Shell

Step 2. Get available payment methods

To be able to display AlipayHK as a payment option on your checkout page, you need to get available payment methods from Airwallex API.

When the PaymentIntent is created, send a GET request with parameters country_code, transaction_currency, transaction_mode to API endpoint /api/v1/pa/config/payment_method_types to query for a list of available payment method based on the information provided. The response will also contain the required fields and necessary resources of each payment method for you to display them on your page.

Request:

Response: Render payment methods in items to show all available payment methods to the shopper at checkout page.

Shell
Note for available payment methods:

Alternatively, you can maintain available payment methods and corresponding resources locally on your server if you do not want to use this API endpoint. However, we highly recommend you get available payment methods dynamically from this API to avoid any trouble when payment method information or resources get updated.

Step 3. 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:

Shell

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

Shell
  • 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

Shell