AlipayHK Redirect Component

Add AlipayHK to an existing Components integration.

If you are using Android Components v5.0.0 or later:

This payment method requires no additional configuration.

Follow the Components integration guide and use the following module and Component names:

To import the module: instant
To launch and show the Component: InstantPaymentComponent

You do not need to collect any information from your shopper in your payment form. If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to the AlipayHK app or website where they can complete the payment.

When making an AlipayHK payment, you need to:

Include AlipayHK in the list of available payment methods.
Handle the redirect.

Requirements

Requirement	Description
Integration type	Make sure that you have built an Advanced flow Android Components integration.
Setup steps	Before you begin, add AlipayHK in your Customer Area.

Show AlipayHK in your payment form

Specify in your /paymentMethods request:
- countryCode: HK
- amount.currency: HKD

The response contains paymentMethod.type: alipay_hk.

We provide logos for AlipayHK which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

When the shopper proceeds to pay, you need to:

From your server, make a /payments request, specifying:
- paymentMethod.type: Set this to alipay_hk.
- returnURL: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).
In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

Use the Redirect Component to redirect the shopper to AlipayHK.
After the shopper returns to your app, make a POST /payments/details request from your server, providing:
- details: The actionComponentData.details object from the Redirect Component.

You receive a response containing:

resultCode: Use this to present the payment result to your shopper.
pspReference: Our unique identifier for the transaction.

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for AlipayHK are:

resultCode	Description	Action to take
Authorised	The payment was successful.	Inform the shopper that the payment has been successful. You will receive the funds in 3 days.
Cancelled	The shopper canceled the payment while on AlipayHK's website.	Ask the shopper whether if they want to continue with the order, or ask them to select a different payment method.
Pending or Received	The shopper has completed the payment but the final result is not yet known.	Inform the shopper that you have received their order, and are waiting for the payment to be completed. To know the final result of the payment, wait for the AUTHORISATION webhook.
Refused	The payment was refused by the shopper's bank.	Ask the shopper to try the payment again using a different payment method.

If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:

eventCode	success field	Description	Action to take
AUTHORISATION	false	The transaction failed.	Cancel the order and inform the shopper that the payment failed.
AUTHORISATION	true	The shopper successfully completed the payment.	Inform the shopper that the payment has been successful and proceed with the order.

Test and go live

Use the following credentials to test AlipayHK:

Username	PIN
hkbuyer_4659@alitest.com	b111111

Check the status of AlipayHK test payments in your Customer Area > Transactions > Payments.

Before you can accept live AlipayHK payments, you need to submit a request for AlipayHK in your live Customer Area.