Accept AlipayHK payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add AlipayHK to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your AlipayHK integration:
- Make sure that you have set up your back end implementation.
- Add AlipayHK in your test Customer Area.
Build your payment form for AlipayHK
Include AlipayHK in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide logos for AlipayHK which you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:
The response contains
Make a payment
In your /payments request, specify:
The /payments response contains an
action object with the information needed to redirect the shopper.
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the 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.