Payment-method icon

Alipay HK for API only

Add Alipay HK to your API-only integration.

You can add Alipay HK to your existing integration. The following instructions show only what you must add to your integration specifically for Alipay HK.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to that corresponding step of the main integration guide.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Redirect handling Make sure that your existing integration is set up to handle the redirect.
action.type: redirect.
Setup steps Before you begin, add Alipay HK in your Customer Area.

How it works

  1. The shopper selects Alipay HK as the payment method.
  2. The shopper enters their details in the payment form that you build.
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase, if applicable.
  4. Your existing integration setup will handle the redirect.

Build your payment form

Include AlipayHK in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.

You can download the logo for Alipay HK to use in your form.

Get Alipay HK as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that Alipay HK is included in the response.

Parameter Values
countryCode HK
amount.currency HKD

Add additional parameters to your /payments request

You do not need to add any parameters when you make a payment.

Test and go live

You can test your Alipay HK integration in two ways: with the Adyen Payment Simulator, or directly with Alipay HK.

Test with Adyen

Use the Adyen Payment Simulator to verify that your Alipay HK integration works correctly with Adyen. You can test during development, before you go live, and after launch. The simulator does not recreate the shopper's journey through the Alipay HK app or website.

This testing option is available by default when you add Alipay HK in your test Customer Area. The payment method type is alipay_hk.

To test a redirect payment:

  1. Start a payment as usual in your integration. The shopper is redirected to an Adyen-hosted simulator page.
  2. Select the payment outcome that you want to test.
  3. Wait for the simulator to return the shopper to your website, then complete the payment as usual. For an Advanced flow, make a /payments/details request.
  4. Confirm that your integration handles the outcome that you selected, and that the payment appears in your Customer Area > Payments > Payment list.

Test directly with AlipayHK

Use the following credentials to test AlipayHK:

Username PIN
hkbuyer_4659@alitest.com b111111

Check the status of direct AlipayHK test payments in your Customer Area > Payments > Payment list.

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

See also