# Alipay HK

**AlipayHK is a digital wallet available for download in the Hong Kong App or Play Store. It's a popular payment method with over 2,000 stores (online and physical) in Hong Kong already accepting it. AlipayHK is only available in Hong Kong.**

## **Features**

| Processing currencies      | HKD,GBP,USD,EUR                          |
| -------------------------- | ---------------------------------------- |
| Settlement currencies      | GBP,USD,EUR,HKD                          |
| Minimum transaction amount | 0.01 HKD                                 |
| Maximum transaction amount | 5,000 HKD 50,000 HKD with authentication |
| Refunds                    | ✅                                        |
| Partial Refunds            | ✅                                        |
| Multiple partial refund    | ❌                                        |
| Chargeback                 | ❌                                        |

# **Integration Method**

**Payment method enumeration values:** **`alipay_hk`**

**There is integration method for Alipay HK**

1. Direct API

## **Direct** **API** 

### **How to integration**

For direct API integration, you can create a PaymentIntent and get url in only one step. The following is the demo of creating payment intent:

[**Create a PaymentIntent**](api-42631218)

A PaymentIntent is an object that represents your intent to collect payment from your customer and tracks the lifecycle of the payment process. Create a PaymentIntent on your server and specify the amount to collect and a supported currency. If you have an existing Payment Intents integration, add **`alipay_hk`** to the list of payment method types.

***Request***  Create a PaymentIntent

```JSON
{
    "amount":1000,
    "currency":"HKD",
    "confirm":true,
    "payment_method_options": {
        "alipay_hk": {
            "terminal_type": "WAP",
            "os_type": "IOS"
        }
    },
    "payment_method_data" : {
        "type":"alipay_hk"
    },
     "return_url":"https://yourwebsite.com"
   }
```

***Response***

```JSON
{
    "id": "pi_1744660317285122048",
    "object": "payment_intent",
    "created": 1704794409000,
    "livemode": false,
    "currency": "HKD",
    "amount": 1000,
    "status": "requires_action",
    "client_secret": "pi_1744660317285122048_secret_9ZeOlYiOojL5KRjjWG6Xgh45",
    "next_action": {
        "type": "alipay_hk_handle_redirect",
        "alipay_hk_handle_redirect": {
            "url": "https://psp.ac.alipay.com/page/simulation-wallet/acwallet/alipayconnectcode.html?code=2816660400931LVf2tlsC2tUk032Aan5AICE&pspName=ALIPAY_HK&loadMode=2"
        }
    },
    "payment_method_types": [
        "alipay_hk"
    ],
    "confirmation_method": "automatic",
    "payment_method_options": {
        "alipay_hk": {
            "terminal_type": "WAP",
            "os_type": "IOS"
        }
    },
    "return_url": "https://yourwebsite.com",
    "payment_method": "pm_1744660317192847360",
    "capture_method": "automatic"
}
```

# **Next step**

You can add more features to your integration as needed

## [Create a Webhook](doc-2517709)

Listen to events on your WooshPay account so your integration can automatically trigger reactions. Create a webhook that mainly focuses on enabled_events and url.

## [Create a Refund](api-51369554)

Create a refund to repay funds to your customer. You can also perform partial refunds, but not every payment method supports them. A partial refund is when you refund only part of the original transaction amount.