AlipayHK for Payment Setup API

Last updated: April 30, 2026

To accept AlipayHK payments, you must:

Create a payment setup.
Confirm the payment.
Redirect the customer to AlipayHK.

Call the Create a payment setup endpoint.

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

post

https://{prefix}.api.checkout.com/payments/setups


1{
2  "amount": 1000,
3  "currency": "HKD",
4  "settings": {
5    "success_url": "https://example.com/payments/success",
6    "failure_url": "https://example.com/payments/failure"
7  }
8}

In the request body, provide the following:

Field	Description
`amount` number	The payment amount, in the minor currency unit. Minimum: 1 Required
`currency` string	Three-letter ISO 4217 currency code. Supported value: `HKD` Required
`settings.failure_url` string	The URL to redirect the customer to if the payment fails. Format: URI Max length: 1024 Required
`settings.success_url` string	The URL to redirect the customer to if the payment is successful. Format: URI Max length: 1024 Required
`customer.email.address` string	The customer's email address. Format: email Max length: 255
`customer.name` string	The customer's name. Min length: 1
`description` string	A description of the payment. Max length: 100
`order.items` array	The list of items in the order. Min items: 1
`order.items[].name` string	The name of the item. Min length: 1
`order.items[].quantity` number	The quantity of the item. Minimum: 1
`order.items[].reference` string	A reference for the item. Min length: 1
`order.items[].unit_price` number	The price per unit of the item, in the minor currency unit. Minimum: 1
`reference` string	A reference you can use to identify the payment. Max length: 80


1{
2  "id": "set_rcmepwrchqab2wsergcafvijfy",
3  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
4  "amount": 1000,
5  "currency": "HKD",
6  "payment_type": "Regular",
7  "reference": "ORD-5023-4E89",
8  "description": "AlipayHK payment",
9  "payment_methods": {
10    "alipay_hk": {
11      "status": "ready",
12      "flags": []
13    }
14  },
15  "available_payment_methods": [
16    "alipay_hk"
17  ],
18  "settings": {
19    "success_url": "https://example.com/payments/success",
20    "failure_url": "https://example.com/payments/failure"
21  }
22}

The response returns a payment_methods object, which contains the payment methods enabled on your account.

When all required fields are present, the payment_methods.alipay_hk object shows a ready status.

Confirm the payment by calling the Confirm a payment setup endpoint and provide:

The payment setup id as the {id} path parameter.
alipay_hk as the payment method name.

post

https://{prefix}.api.checkout.com/payments/setups/{id}/confirm/alipay_hk


1{
2  "id": "pay_bsrduhejxiuerlh32hb5n6dvae",
3  "status": "Pending",
4  "reference": "ORD-5023-4E89",
5  "customer": {
6    "id": "cus_2g4ehcpm6phexgkzahlwxvbgne",
7    "email": "hannah.bret@example.com",
8    "name": "Hannah Bret"
9  },
10  "_links": {
11    "self": {
12      "href": "https://{prefix}.api.checkout.com/payments/pay_bsrduhejxiuerlh32hb5n6dvae"
13    },
14    "redirect": {
15      "href": "https://psp.ac.alipay.com/page/simulation-wallet/acwallet/alipayconnectcode.html?code=281666040099gDeR9hatc6IPfQ0bstyv3kOD&pspName=ALIPAY_HK&loadMode=2"
16    }
17  }
18}

Redirect the customer to the redirect.href URL from the response. The customer completes the payment on the AlipayHK page and is then redirected back to your settings.success_url or settings.failure_url.

When accepting payments with AlipayHK, you must display the Alipay+ and AlipayHK logos on your payment interface. To ensure that the logos match Alipay's requirements, refer to their Brand display guidelines for online payments and Brand display guidelines for cashier payments.

AlipayHK for Payment Setup API

Create a payment setup

Information

Request example

Response example

Confirm the payment

Request example

Response example

Redirect the customer