If you are using Android Drop-in v5.0.0 or later:
This payment method requires no additional configuration.
Follow the Drop-in integration guide.
Our Android Drop-in renders AlipayHK in your payment form, and redirects the shopper to the AlipayHK app or website where they can complete the payment.
Requirements
| Requirement | Description |
|---|---|
| Integration type | Make sure that you have built an Advanced flow Android Drop-in integration. |
| Setup steps | Before you begin, add AlipayHK in your Customer Area. |
Show AlipayHK in your payment form
Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.
To show AlipayHK in your payment form, specify in your /paymentMethods request:
- countryCode: HK
- amount.currency: HKD
Make a payment
When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.
-
Pass the
paymentComponentData.paymentMethodto your server. -
From your server, make a /payments request, specifying:
paymentMethod: ThepaymentComponentData.paymentMethodfrom your client app.returnURL: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in theRedirectComponent.getReturnUrl(context).
In the /payments response, note the action object. This contains the information needed to redirect the shopper.
If your integration is set up correctly, the action object is passed from your server to the client.
Check the payment result
Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData object.
From your server, make a POST /payments/details request providing:
details: TheactionComponentData.detailsobject from Drop-in.
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.