Our AlipayHK Component renders AlipayHK in your payment form. As with other redirect payment methods, you need to use createFromAction
to redirect the shopper, and handle the redirect after the shopper returns 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:
- Make sure that you have set up your back end implementation, and created an instance of
AdyenCheckout
. -
Add AlipayHK in your Customer Area.
Show AlipayHK in your payment form
To present the AlipayHK Component in your payment form:
- From your server, make a /paymentMethods request specifying:
- countryCode: HK
- amount.currency: HKD
-
Pass the full response from the /paymentMethods call as the
paymentMethodsResponse
object when creating an instance of theAdyenCheckout
. - 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 and mount an instance of the AlipayHK Component using its component name,
alipay_hk
. This renders a button on your payment form.function handleOnSubmit(state, component) { // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance state.isValid // True or false. Specifies if all the information that the shopper provided is valid. state.data // Provides the data that you need to pass in the `/payments` call. component // Provides the active component instance that called this event. } const alipayHKComponent = checkout.create('alipay_hk', { onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance }).mount('#alipayHK-container');
When the shopper selects the payment method, the Component calls the
onSubmit
event, which contains astate.data
object including the shopper's selected payment method. If your integration is set up correctly, thestate.data
is passed on to your server.
Make a payment
From your server, make a POST /payments request, specifying:
paymentMethod
: Thestate.data.paymentMethod
from theonSubmit
event from your front end.returnUrl
: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol:http://
orhttps://
. For example,https://your-company.com/checkout/
. You can also include your own additional query parameters, for example, shopper ID or order reference number.
Here is how you would make a payment request for 10 HKD.
curl https://checkout-test.adyen.com/v66/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 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 an action
object with type
: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": "redirectResult",
"type": "text"
}
],
...
}
If your integration is set up correctly, the action
object is passed from your server to the client, and the action.paymentData
temporarily stored on your server.
Handle the redirect
Handling the redirect works the same way for all redirect payment methods:
-
Call
createFromAction
, passing theaction
object from the previous step. This will return a new Component that you need to mount:
The Component redirects the shopper to AlipayHK to complete the payment.checkout.createFromAction(action).mount('#my-container');
-
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
-
paymentData
: The value your 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.
-
resultCode
: Use this to present the payment result to your shopper. -
pspReference
: Our unique identifier for the transaction.
-
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 AlipayHK's 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 the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment:
eventCode | success field | Description | Action to take |
---|---|---|---|
AUTHORISATION | false | The transaction failed. | Cancel the order and inform the shopper that the payment failed. |
AUTHORISATION | true | The shopper successfully completed the payment. | Inform the shopper that the payment has been successful and proceed with the order. |
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.