Last updated: 17 September 2026 | Change log

AlipayHK

A popular digital wallet used in Hong Kong.

Note

Make yourself familiar with our API principles to ensure a resilient integration.

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 - yes Cancel - no	Partial refund - yes Partial 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 and set your headers.

Request

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

Apply APM payment details directly using our APMs API, or use our Components SDK to create a session.

Example requests

Collect the APM details and send an API request with these details to create a payment.

{
  "transactionReference": "Memory265-13/08/1876",
  "orderReference": "apm-order-12345",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "ach",
    "narrative": {
      "line1": "MindPalace"
    },
    "value": {
      "amount": 750,
      "currency": "USD"
    },
    "paymentInstrument": {
      "type": "direct",
      "accountType": "checking",
      "accountNumber": "01234567890123456",
      "routingNumber": "012345678",
      "checkNumber": "012345678901234",
      "companyName": "Worldpay",
      "billingAddress": {
        "address1": "8500 Governors Hill Drive",
        "address2": "Symmes Township",
        "postalCode": "45249",
        "city": "Ohio",
        "state": "US-OH",
        "countryCode": "US"
      }
    },
    "customer": {
      "firstName": "John",
      "lastName": "Johnson",
      "customerId": "43424",
      "email": "john@example.com"
    }
  }
}

Parameters

transactionReferencestring, [ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

For Bizum transactions, please follow this extra regex [a-zA-Z0-9]{4,12}

orderReferencestring, [ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$

A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:

the total amount for a single order is split across multiple payments
you use a single reference for each payment in a recurring agreement or split shipment scenario

merchantobject(MerchantV2)required

instructionobject(InstructionV2)required

Response

Example response

{
  "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"
}

Schema

paymentIdstring

The identifier of the payment resource.

lastEventstring

Enum:"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"

_linksobject(Links)

Links to resources related to the request.

_actionsobject(ActionsV2)

redirectstring

The URL to redirect your customer to, or a QR code in Base64 to show to your customer, in order to complete the transaction.

commandIdstring

An action ID generated by us, identifying a single merchant interaction.

Example:"cmdYNdIHBPJwbkjLiykzTx0"

paymentInstrumentAll others (object) or PayPal (object) or SEPA DD (object) or Klarna (recurring) token (object)(PaymentInstrument)

One of:

Payment instrument for: ACH, Alipay China, Alipay Hong Kong, Alipay Plus, BANCOMAT Pay, Bancontact, Bizum, BLIK, EFT, Euteller, iDEAL guest, iDEAL recurring, Klarna, Klarna (recurring), Konbini, Multibanco, MyBank, Open Banking, PaysafeCard, Pix, Przelewy24, SafetyPay, Satispay, Swish, Trustly, China UnionPay, WeChat Pay.

transactionCodestring

For Pix payments - display to your customer for them to copy and paste in the Pix app.

For Swish payments - use this value as the {token} in the custom URL scheme: swish://paymentrequest?token={token}&callbackurl={callbackURL}. This will prompt the app to open, allowing your customer to complete their payment.

Example:"IZQ3iUfePwiWiwldJlipl8NGVA7w5IUg"

Errors

Check out our API reference for more responses or error codes.

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