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

# Alipay Hong Kong

Coming Soon

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) | Customer Country |
|  --- | --- | --- | --- | --- | --- |
| Digital wallet | ❌ | Refund - yesCancel- No | Partial refund - yesPartial cancel- No | ✅ | Hong Kong |


- Maximum Transaction Value: 50.000 HKD


### Acceptance currencies

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


## Set your headers

Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request.


```
Authorization: {your_credentials}
Content-Type: application/json
WP-Api-Version: 2023-06-01
```

| Header | Description |
|  --- | --- |
| `Authorization` | We use the `Authorization` header to identify and authenticate you within Access Worldpay. You **must** use the `Authorization` header for any request you send to our APM API. |
| `Content-Type` | We require the `Content-Type` header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`. |
| `WP-Api-Version` | We use the `WP-Api-Version` header to identify which version of our APM API you are using. You **must** use the `WP-Api-Version` header for any request you send to our API. |


If you're using both the `Content-Type` and `WP-Api-Version` headers, they must match.

Note
Replace `{your_credentials}` with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.

## Take a payment

`POST` `https://try.access.worldpay-bsh.securedataplatform.com/apmPayments`

#### Example request

{
    "transactionReference": "Memory265-13/08/1876",
    "merchant":
    {
        "entity": "default"
    },
    "instruction":
    {
        "narrative":
        {
            "line1": "Mind Palace Ltd"
        },
        "value":
        {
            "amount": 1234,
            "currency": "HKD"
        },
        "paymentInstrument":
        {
            "type": "alipay_hk",
            "successURL": "http://httpbin.org/anything/success",
            "pendingURL": "http://httpbin.org/anything/pending",
            "failureURL": "http://httpbin.org/anything/failure",
            "deviceType": "MOBILE"
        }
    }
}

### Parameters

| Parameter | Required? | Description | Data type | Length |
|  --- | --- | --- | --- | --- |
| `transactionReference` | ✅ | A unique reference generated by you that is used to identify a payment throughout its lifecycle. See [transaction reference format](/products/reference/formatting#transaction-reference-format). | String | Must be between 1 to 64 characters. |
| `merchant` | ✅ | An object that contains information about the merchant. | Object | N/A |
| `merchant.entity` | ✅ | Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for Authentication and Queries.Contact your Implementation Manager for more details. | String | Must be between 1 and 32 characters. |
| `instruction` | ✅ | An object that contains all the information related to the payment. | Object | N/A |
| `instruction.narrative` | ✅ | An object that helps your customers better identify you on their statement. | Object | See our [formatting rules](/products/reference/formatting#narrative-format) |
| `instruction.narrative.line1` | ✅ | The first line of the narrative which appears on your customer's statement (If a character is not supported it is replaced with a space.).See [narrative `line1` format](/products/reference/formatting#narrative-line1) for more details. | Object | 24 |
| `instruction.value` | ✅ | An object that contains information about the payment transaction. | Object | N/A |
| `instruction.value.amount` | ✅ | The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2,50. You can find the relevant exponent in our [currency table](/products/reference/supported-countries-currencies#iso-currency-codes). | Integer | N/A |
| `instruction.value.currency` | ✅ | The payment currency. Refer to the individual APM page for supported currencies. | Integer | 3 |
| `instruction.paymentInstrument` | ✅ | An object that contains information about the payment method. | Object | N/A |
| `instruction.paymentInstrument.type` | ✅ | An object that contains the payment type and details. It defines which alternative payment method you wish to use. Value is `alipay_hk`. | Object | N/A |
| `instruction.paymentInstrument.successURL` | ✅ | When we receive the payment result for a successful payment, we redirect your customer to that success URL. | String | N/A |
| `instruction.paymentInstrument.pendingURL` | ✅ | When we receive the payment result for a pending payment transaction, we redirect your customer to that pending URL. | String | N/A |
| `instruction.paymentInstrument.failureURL` | ✅ | When a payment fails, we redirect your customer to the failure URL. | String | N/A |
| `instruction.paymentInstrument.deviceType` | ❌ | Your customer's device type. Possible values: "DESKTOP" (default)"MOBILE""CONSOLE""TABLET" | String | Must be between 1 and 32 characters. |


## Response

#### Successful request response

* an HTTP code `201`
* an `id` which is unique to the payment - we recommend storing the "id" as this can be used 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


### Example Response

{
    "paymentId": "nFxASqw-LV9HE_rr1mMONJmqBDeXmnv5dzt9IxAXgXbfpu0O_8mOnTpFSIM9gnTSygCKQgvlwQdUbu5rExIpJA_5Uq2LEGXXAanycRpxfDPNA-E70zIWdnaMb2gJhC8AIhbOkM6xDiVNu90YCXo2snTzi_k1sEOQnKIAJNTW3Qc",
    "lastEvent": "pending",
    "_links": {
        "self": {
            "href": "https://access.worldpay-bsh.securedataplatform.com/apmPayments/nFxASqw-LV9HE_rr1mMONJmqBDeXmnv5dzt9IxAXgXbfpu0O_8mOnTpFSIM9gnTSygCKQgvlwQdUbu5rExIpJA_5Uq2LEGXXAanycRpxfDPNA-E70zIWdnaMb2gJhC8AIhbOkM6xDiVNu90YCXo2snTzi_k1sEOQnKIAJNTW3Qc"
        }
    },
    "_actions": {},
    "url": "https://payments.worldpay-bsh.securedataplatform.com/app/hpp/integration/wpg/corporate?OrderKey="
}
Note
In case of an error, you can get further information in our [error reference](/products/reference/worldpay-error-responses).

**Next Steps**

[Manage your AlipayHK payment](/products/apms/20230601/manage)