---
title: "Alipay HK for API only"
description: "Add Alipay HK to your API-only integration."
url: "https://docs.adyen.com/payment-methods/alipayhk/api-only"
source_url: "https://docs.adyen.com/payment-methods/alipayhk/api-only.md"
canonical: "https://docs.adyen.com/payment-methods/alipayhk/api-only"
last_modified: "2026-05-24T12:54:31+02:00"
language: "en"
---

# Alipay HK for API only

Add Alipay HK to your API-only integration.

[View source](/payment-methods/alipayhk/api-only.md)

You can add Alipay HK to your existing integration. The following instructions show only what you must add to your integration specifically for Alipay HK.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to that corresponding step of the main integration guide.

## Requirements

| Requirement           | Description                                                                                                                                                                                                                |   |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - |
| **Integration type**  | Make sure that you have an existing [API-only integration](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only).                                                                   |   |
| **Redirect handling** | Make sure that your existing integration is set up to [handle the redirect](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#handle-the-redirect). `action.type`: **redirect**. |   |
| **Setup steps**       | Before you begin, [add Alipay HK in your Customer Area](/payment-methods/add-payment-methods).                                                                                                                             |   |

## How it works

1. The shopper selects Alipay HK as the payment method.
2. The shopper enters their details in the [payment form that you build](#build-your-payment-form).
3. When you make the payment request, you [include additional information about the items that the shopper intends to purchase](#additional-parameters-payments), if applicable.
4. Your existing integration setup will [handle the redirect](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#handle-the-redirect).

## Build your payment form

Include AlipayHK in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.

You can [download the logo for Alipay HK](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%2Bonly\&version=71#downloading-logos) to use in your form.

## Get Alipay HK as an available payment method

When you make the [/paymentMethods](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods) to [get available payment methods](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#get-available-payment-methods), specify the following so that Alipay HK is included in the response.

| Parameter                                                                                                          | Values      |
| ------------------------------------------------------------------------------------------------------------------ | ----------- |
| [countryCode](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods#request-countryCode)         | ****HK****  |
| [amount.currency](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods#request-amount-currency) | ****HKD**** |

**Example request for available payment methods**

```bash
curl https://checkout-test.adyen.com/v72/paymentMethods \
-H 'x-api-key: ADYEN_API_KEY' \
-H 'idempotency-key: YOUR_IDEMPOTENCY_KEY' \
-H 'content-type: application/json' \
-X POST
-d '{
   "merchantAccount": "ADYEN_MERCHANT_ACCOUNT",
   "countryCode": "HK",
   "amount": {
      "currency": "HKD",
	  "value": 1000
   },
   "shopperLocale": "hk-HK"
}'
```

**Example response with Alipay HK available**

```json
{
    "paymentMethods": [
        {
            "name": "Alipay HK",
            "type": "alipay_hk"
        }
    ]
}
```

## Add additional parameters to your /payments request

You do not need to add any parameters when you [make a payment](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#make-a-payment).

## Test and go live

Use the following credentials to test AlipayHK:

| Username                   | PIN     |
| -------------------------- | ------- |
| <hkbuyer_4659@alitest.com> | b111111 |

Check the status of AlipayHK test payments in your [Customer Area](https://ca-test.adyen.com/) > **Transactions** > **Payments**.

Before you can accept live AlipayHK payments, you need to submit a request for AlipayHK in your [live Customer Area](https://ca-live.adyen.com/).

## See also

* [API-only integration guide](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only)