Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

AlipayHK for API only

Add AlipayHK to an existing API-only integration.

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:

  1. Make sure that you have set up your back end implementation.
  2. 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 paymentMethod.type: alipay_hk.

Make a payment

In your /payments request, specify:

  • paymentMethod.type: alipay_hk
curl https://checkout-test.adyen.com/v52/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"HKD",
    "value":1000
  },
  "paymentMethod":{
    "type":"alipay_hk"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "HKD",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "alipay_hk"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("HKD");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("alipay_hk");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "HKD",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "alipay_hk"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'HKD'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'alipay_hk'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("HKD", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "alipay_hk"
};
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "HKD", value: 1000 },
    paymentMethod: {
        type: 'alipay_hk'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "my-app://"
}).then(res => res);

The /payments response contains:

  • action.url: Link to where you should redirect your shopper.
  • action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
    The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

To verify the payment result in the next step, you also need the following from the /payments response:

  • action.paymentData: The paymentData value that you send in your /payment/details request.
  • details: Array of parameters that you need to send in your /payment/details request. For example, payload or redirectResult.
    The parameters can vary based on the payment method configuration. Make sure to check the details array to confirm the parameters that you need to send in your next API request.
/payments response
{
   "resultCode":"RedirectShopper",
   "action":{
      "method":"GET",
      "paymentData":"Ab02b4c0!BQABAgCSZT7t...",
      "paymentMethodType":"alipay_hk",
      "type":"redirect",
      "url":"https://test.adyen.com/hpp/redirect.shtml?brandCode=.."
   },
   "details":[
      {
         "key":"payload",
         "type":"text"
      }
   ],
   ...
}

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.
  2. After the shopper is redirected back to your website or app, check the payment result by making a /payments/details request, specifying:
    • paymentData: Value you received in the /payments response.
    • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your website or app. For example, payload. To check the parameters that you should submit, refer to the details array that you received in the /payments response.
    /payments/details request
    {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "{hint:Verify the parameters from /payments response}payload{/hint}":"Ab02b4c0!BQABAgCW5sxB4e/=="
         }
    }
    You receive a response containing:
    • resultCode: Use this to present the result to your shopper.
    • pspReference: Our unique identifier for the transaction.
    /payments/details response
     {
       "resultCode": "Authorised",
       "pspReference": "88154795347618C"
     }
For more information and detailed instructions, refer to Handling redirects.

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 the Alipay 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 notification.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.
If a shopper completed the payment but failed to return to your website or app, you will receive the outcome of the payment in an AUTHORISATION notification.

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.

See also