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 BrowserMobile App
Mobile Website Browser
IndonesiaJapanKoreaMalaysiaPhilippinesSingaporeThailandTaiwan
US & LATAM

Mobile App

Accept Alipay HK on your mobile app on your shopper’s Android or iOS phone. You can choose to integrate Airwallex mobile SDK that supports multiple payment methods. See checkout experience as below

  1. The shopper chooses to pay with Alipay HK
  2. The shopper reviews transactions and confirm to pay
  3. The shopper is redirected to Alipay HK App and completes payment
  4. Payment succeeds and the shopper is redirected back to your App

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 Alipay HK App to complete payment

When a shopper selects to pay with Alipay HK on their Mobile App, call the following API endpoints to get a e-wallet cashier URL, which you can redirect the shopper to Alipay HK APP to complete payment.

  1. Obtain URL from Airwallex and redirect shopper to Alipay HK App

Request:

Shell

Response:

Shell
  1. 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 Alipay HK.

  1. Query the PaymentIntent status (Optional)

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

Shell