AlipayHK Component

Our AlipayHK Component renders AlipayHK in your payment form. When making an AlipayHK payment, you additionally need to use createFromAction to handle the redirect to AlipayHK and back to your website.

Before you begin

This page explains how to add AlipayHK to your existing Web Components integration. The Web 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:

1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
2. Add AlipayHK in your test Customer Area.

Show AlipayHK in your payment form

To present the AlipayHK Component in your payment form:

1. From your server, make a /paymentMethods request specifying:
   • countryCode: HK
   • amount.currency: HKD

2. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

3. Add the AlipayHK Component:
   a. Create a DOM element for AlipayHK, placing it where you want the form to be rendered:

   <div id="alipayhk-container"></div>

   b. Create an instance of the AlipayHK Component, and mount it.

    const alipayhk = checkout.create('alipay_hk').mount('#alipayhk-container');

Make a payment

When the shopper selects to pay, the Component calls the onChange event, which contains a state.data.

1. If state.isValid is true, collect the state.data and pass this to your server.

2. From your server, make a /payments, specifying:

   • paymentMethod: The state.data.paymentMethod from the onChange event from your front end.
   https://docs.adyen.com/payment-methods/alipayhk/web-component#alipayhk-payments

   • curl
   • Ruby
   • Java
   • PHP
   • Python
   • C#
   • NodeJS

   curl Ruby Java PHP Python C# NodeJS

   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
     },
     "{hint:state.data.paymentMethod from onChange or onSubmit}paymentMethod{/hint}":{
       "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: "https://your-company.com/checkout?shopperOrder=12xy.."
   }).then(res => res);

   The /payments response contains:

   • 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, you also need the following from the /payments response:

   • action.paymentData: Store this on your server — this is the paymentData value that you send in your /payments/details request.
   • details: Array of parameters that you need to send in your /payments/details request. For example, payload or redirectResult.
     The parameters can vary based on the payment method configuration. Always check the details array for the parameters that you need to send in your next API request.
   https://docs.adyen.com/payment-methods/alipayhk/web-component#-payments-response

   /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"
     }
   ],
   ...
   }
3. Pass the action object to your front end.

Handle the redirect result

1. Call createFromAction and pass the action object from the previous step. This will return a new Component that you need to mount:

      checkout.createFromAction(action).mount('#my-container');

   The Component redirects the shopper to AlipayHK's website where they scan a QR code and complete the payment.

2. After the shopper is redirected back to your website, 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 site. For example, payload. To check the parameters that you should submit, refer to the details array that you received in the /payments response.
   https://docs.adyen.com/payment-methods/paymaya/web-component#-payments-details-request

   /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.
   https://docs.adyen.com/payment-methods/paymaya/web-component#-payments-details-response

   /payments/details response

   {
     "resultCode": "Authorised",
     "pspReference": "88154795347618C"
   }

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:

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.

See also