Our iOS Drop-in renders AlipayHK in your payment form, and redirects the shopper to the AlipayHK app or website where they can complete the payment.
When making an AlipayHK payment, you additionally need to:
- Handle the redirect result after the shopper returns to your website.
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:
- Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
- 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
.
- Pass
data.paymentMethod
to your server. -
From your server, make a /payments request, specifying:
-
paymentMethod
: Thedata.paymentMethod
from thedidSubmit
event from your client app.
curl https://checkout-test.adyen.com/v51/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 paymentsRequest = new 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);
The /payments response contains:
-
action
: Object containing information about the redirect.
{ "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" } ], ... }
-
- 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. However, you need to inform Drop-in when the shopper returns to your app. To do this, implement the following in your UIApplicationDelegate
:
func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
RedirectComponent.applicationDidOpen(from: url)
return true
}
After the shopper is redirected back to your app, check the payment result by making a /payments/details request.
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 they want to continue with the order, or request that they 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. |
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.