AlipayHKAlipayHKDOCS

Payment Order

This page discuss the extended information for payment order scenarios, please also check the base API.

Order Status

Flow Chart

image.png

Notification can start from any status below and status can be skipped if necessary.

Order Status

Description

Display Sample (Index Page)

WAIT_PAY

When the user has to pay.

image

PAY_FAILED

When the autodebit process failed.

image.png

OVERDUED

When the bill has overdued.

image.png

CLOSED

When the order completes.

Notification will disappear.

Business Info

This part describes the languageBusinessInfo in dataInfo of the API.

All fields are required when order status is WAIT_PAY, optional otherwise.

Name

Description

Type

Sample

action_url

An URL to proceed when user clicks the button.

String

"alipayhk://platformapi/startapp?appId=2102020185475244&page=pages/alipay/orderDetail/index?orderCode=20240421389609183133"

bill_amount

Amount of this bill in cents. (1 = $0.01, 100 = $1)

String

"10000"

bill_amount_currency

Currency of bill_amount, supports HKD or CNY.

String

"HKD"

bill_desc

Description of the bill.

String

"Bill of May"

bill_due_time

Due date of this bill in yyyy-MM-dd.

String

"2024-05-30"

bill_icon_url

An URL of the notification's icon.

String

"https://www.alipayhk.com/wp-content/uploads/2022/01/AlipayHK_logo.png"

bill_name

Name of the bill.

String

"AlipayHK"

order_url

An URL to redirect when user clicks the notification but not the button.

String

"alipayhk://platformapi/startapp?appId=2102020185475244&page=pages/alipay/orderDetail/index?orderCode=20240421389609183133"

Example

copy
{
    "zh_HK": {
        "bill_desc": "煤氣十月賬單已發出",
        "bill_name": "煤氣賬單",
        "bill_due_time": "2024-10-15",
        "bill_amount": "57000",
        "bill_amount_currency": "HKD",
    "bill_icon_url": "https://www.alipayhk.com/wp-content/uploads/2022/01/AlipayHK_logo.png",
        "action_url": "alipayhk://platformapi/startapp?appId=210202018547xxxx",
        "order_Url": "alipayhk://platformapi/startapp?appId=210202018547xxxx"
    },
    "en_US": {
        "bill_desc": "OCT Gas Bill Issued",
        "bill_name": "GAS BILL",
        "bill_due_time": "2024-10-15",
        "bill_amount": "57000",
        "bill_amount_currency": "HKD",
    "bill_icon_url": "https://www.alipayhk.com/wp-content/uploads/2022/01/AlipayHK_logo.png",
        "action_url": "alipayhk://platformapi/startapp?appId=210202018547xxxx",
        "order_Url": "alipayhk://platformapi/startapp?appId=210202018547xxxx"
    }
}