**Last updated**: 06 November 2025 | [**Change log**](/products/apms/changelog/)

# AlipayHK

A popular digital wallet used in Hong Kong.

Note
Make yourself familiar with our [API principles](/products/reference/api-principles) to ensure a resilient integration.

details
summary
Product overview
## Why use AlipayHK?

AlipayHK is a key payment method in Hong Kong with approximately 2.7 million active users. It is the most popular digital wallet in Hong Kong, accepted at over 100.000 physical and online stores.

This payment method allows local residents to gain access to one of Hong Kong's most popular payment methods without the need to register for a Hong Kong bank account.

AlipayHK supports mobile application and website payments.

### Feature summary

| Payment type | Recurring | Reversals | Partial Reversals | Auth and Settlement (Sale) |
|  --- | --- | --- | --- | --- |
| Digital wallet | ❌ | Refund - yesCancel- No | Partial refund - yesPartial cancel- No | ✅ |


- Maximum Transaction Value: 50.000 HKD


### Acceptance currencies

| Currency | Currency Codes |
|  --- | --- |
| Euro | EUR |
| Hong Kong Dollar | HKD |
| Pound Sterling | GBP |
| Singapore Dollar | SGD |


## Get started

Get started using our [API reference](/products/apms/openapi) and set your headers.

## Request

`POST` `https://try.access.worldpay.com/apmPayments`

### Example requests

### Parameters

## Response

#### Successful request response

* an HTTP code 201
* a `paymentId` which is unique to the payment - we recommend storing the "id", as you can use it to manage the payment later
* a url to redirect your customer to the APM provider to complete the payment
* a link to query the payment status
* an object which will give flow information such as `method` (e.g. `alipayhk`) and type (`direct`)
* a `commandId` generated by us identifying a single merchant interaction (e.g. `cmdYNdIHBPJwbkjLiykzTx0`)


### Example response

Successful
{
  "paymentId": "HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ5v2I5ddQFtUqfQjfH6MtZWlDSUrxrcX5x_wn93uYUZBrpxTgfQTxtQsmy9dE_z-m-zZvrP-LeCRz0uWrqdvJK9lFEMgr042IFWuXU4qz5JB5ruD3eXP8P1s6nqEcRq5d-NwnkVtXPzEhC9FQ_77m3c"
    }
  },
  "_actions": {},
  "redirect": "https://secure-test.worldpay.com/jsp/test/shopper/APMSTSimulator.jsp?customerRef=3413879489&paymentMethod=ALIPAY_HK",
  "paymentInstrument": {
    "method": "alipay_hk",
    "type": "direct"
  },
  "commandId": "cmdEy5vwB0krLe9eMwAcE66c0"
}
Error response
{
  "errorName": "bodyDoesNotMatchSchema",
  "message": "The json body provided does not match the expected schema",
  "validationErrors": [
    {
      "errorName": "fieldHasInvalidValue",
      "message": "Field is mandatory",
      "jsonPath": "$.instruction.value.amount"
    }
  ]
}
#### Errors

Check out our API reference for the full [error code schema](/products/apms/openapi/other/payment#other/payment/response&c=400).

**Next steps**

[Manage your Alipay Hong Kong payment](/products/apms/manage/)