AlipayHK Drop-in integration

Our iOS Drop-in renders AlipayHK in your payment form, and redirects the shopper to complete the payment. As with other redirect payment methods, you need to handle the redirect result after the shopper returns to your app.

Before you begin

This page explains how to add AlipayHK to your existing iOS Drop-in integration. The iOS Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.

Before starting your AlipayHK integration:

1. Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
2. Add AlipayHK in your test 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 invokes the didSubmit method which contains data.paymentMethod.

1. Pass data.paymentMethod to your server.

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

   • paymentMethod: The data.paymentMethod from the didSubmit event from your client app.
   curl Ruby Java PHP Python C# NodeJS

   curl Ruby Java PHP Python C# NodeJS

   curl https://checkout-test.adyen.com/v68/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:data.paymentMethod from didSubmit}paymentMethod{/hint}":{
       "type":"alipay_hk"
     },
     "returnUrl":"my-app://"
   }'

   # 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 => "my-app://",
     :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("my-app://");
   
       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" => "my-app://",
     "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': 'my-app://',
      '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 = @"my-app://",
     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);

   https://docs.adyen.com/payment-methods/alipayhk/ios-drop-in#alipayhk-payments

   The /payments response contains an action object with the information needed to redirect the shopper.
   

   /payments response

   {
   "resultCode":"RedirectShopper",
   "action":{
     "paymentMethodType":"alipay_hk",
     "method":"GET",
     "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
     "type":"redirect"
   }
   }

   https://docs.adyen.com/payment-methods/online-banking-india/api-only#-payments-response

3. Pass the action object to your client app. Drop-in needs this to redirect the shopper to the AlipayHK app or website.

Handle the redirect result

Drop-in redirects the shopper to the AlipayHK app or website where they complete the payment.  

1. To inform Drop-in when the shopper returns to your app, implement the following in your UIApplicationDelegate:

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
    RedirectComponent.applicationDidOpen(from: url)
    return true
}

After Drop-in completes the action, it invokes the didProvide method.

2. From your server, make a POST /payments/details request providing the data from the didProvide method from your client app.

  curl https://checkout-test.adyen.com/v68/payments/details \
  -H "x-API-key: YOUR_X-API-KEY" \
  -H "content-type: application/json" \
  -d '{
       "details": {
         "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
     }
  }'

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": "FJM726V375BV9D82"
  }

  https://docs.adyen.com/payment-methods/gcash/ios-drop-in#-payments-details-response

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:

If the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment:

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