**Last updated**: 13 March 2026 | [**Change log**](/access/products/apms/changelog/)

# AlipayHK

A popular digital wallet used in Hong Kong.

Note
Make yourself familiar with our [API principles](/access/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

Use our [API reference](/access/products/apms/openapi) and set your headers.

## Request

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

### Example requests

### Parameters

## Response

### 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

```json
{
  "errorName": "bodyDoesNotMatchSchema",
  "message": "The json body provided does not match the expected schema",
  "validationErrors": [
    {
      "errorName": "fieldHasInvalidValue",
      "message": "Field is mandatory",
      "jsonPath": "$.instruction.value.amount"
    }
  ]
}
```

### Schema

#### Errors

Check out our API reference for [more responses or error codes](/access/products/apms/openapi/other/payment#other/payment/response&c=400).

## Simulation

To simulate payment outcomes and trigger webhooks in our Try environment you can send a request prompting our simulator.

You receive a `redirect` link to our simulator where you can choose different payment outcomes:

| Simulator outcome option | Payment status | Description |
|  --- | --- | --- |
| Authorised | `authorized` | Payment authorized successfully. |
| Authorised and Captured | `sentForSettlement` | Your customer’s payment is in the process of being settled. |
| Refused | `refused` | Unsuccessful payment - failure response from the provider. |
| Error | `error` | Error in processing the payment or the session timed out. |
| Shopper Cancelled | `cancelled` | Your customer cancelled the transaction. |


Furthermore, you can use magic values in amount to generate specific outcomes. Adding an amount other than the below magic values shows a happy path.

| Simulator flow | Magic value | Outcome |
|  --- | --- | --- |
| Sale | 500 | Error in sale response |
| Reversals with amount | 700 | Error in reversal response, received via webhooks |


**Next steps**

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