You don't 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:
Before you begin
This page explains how to add AlipayHK to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.
Before starting your AlipayHK integration:
- Make sure that you have set up your back end implementation for making API requests.
- Add AlipayHK in your test Customer Area.
Show AlipayHK in your payment form
The response contains
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
The /payments response contains an
actionobject with the information needed to redirect the shopper.
- Pass the
actionobject 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:
actionComponentData.detailsobject 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
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've 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.|
|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:
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.