Alipay HK

Features
Method	Async - GET Redirect
Merchant countries	Hong Kong
Consumer countries	China, Hong Kong
Processing currencies	HKD
Increments	-
Captures	-
Partial/Multiple partial captures	-
Cancels	-
Partial/Multiple partial cancels	-
Refunds	✅
Partial/Multiple partial refunds	✅ (Only one partial refund allowed)
Recurring	-
Installments	-
Credits	-
Disputes	-
Min Amount	0.1
Account verification	-

AlipayHK is an eWallet app that lets users store debit or credit card details to make online and in-store purchases using their phones. It works as a mobile wallet-based payment method, similar to the likes of Apple Pay. AlipayHK can be used to make purchases where the merchant has listed AlipayHK as a valid form of payment.

When a consumer shops online using the AlipayHK payment method, the merchant sends a payment to the PSP.

There are two ways to make Alipay HK payments:

• qr_link: The returned redirection URL is a QR link to complete the purchase. The merchant redirects the customer to a page where the customer scans the QR code using the Alipay app to complete the purchase.

• mobile_redirect: The returned redirection URL is a link to open the Alipay application or Alipay web to complete the purchase. The merchant redirects the customer who is using a mobile web browser.

Payment flow

Payment

Request

{
    "processingAccountId": "2HdN2jq6XWmlkhqRC2gDTNYCvNH",
    "merchantReference": "c5211d6b-0178-49f8-a06b-69df097a712f",
    "amount": {
        "value": 200,
        "currency": "hkd"
    },
    "paymentMethod": {
        "type": "alipay_hk",
        "alipayHk": {
            "returnUrl": "https://merchant.site/complete-payment",
            "flowType": "qr_link"
        }
    }
}

Response

{
    "id": "27yiW9MgzBtwiodreuNOXk0rtIw",
    "merchantReference": "c5211d6b-0178-49f8-a06b-69df097a712f",
    "status": "pending",
    "trackingUrl": "/v1/tracks/payments/{trackId}",
    "reason": {
        "code": "required_next_step",
        "description": "An additional step is needed to complete the payment."
    },
    "nextStep": {
        "type": "redirect",
        "redirect": {
            "method": "get",
            "url": "https://payment.method/complete"
        }
    }
}