AlipayHKAlipayHKDOCS

Order Notification

Order Notification

The Order Notification API is for merchants to synchronize transaction information to AlipayHK. With this information, AlipayHK can link the main transaction and add-on transactions.

Body

Field

Type

Descript

Sample

orderId

String

AlipayHK bill number

20250306194010800100160900280950024

merchantTransId

String

Request ID to create alipay transaction. It will be an UUID in this scenario.

fdy9730943y0egh38eh10sj219sj09r1

createTime

String

2024-05-16T14:29:21+08:00

paymentTime

String

2024-05-16T14:29:21+08:00

orderStatus

String

  • SUCCESS : user successfully pay
  • CLOSE : user fails pay

order

Order

Order infomation

copy
{
    "orderAmount": {
        "amount": 1.08,
        "currency": "HKD"
    },
    "goodsList": [
        {
            "price": {
                "amount": 1.08,
                "currency": "HKD"
            },
            "quantity": "1",
            "title": "u6D4Bu8BD5u6350u8D60u6807u9898"
        }
    ]
}

userInfo

PaySiteUserInfo

User infomation

{

   "loginId": "852-45****88",

   "userId": "2160120051483575"

}

extendInfo

String

{\"contentId\":\"110123450002\",\"spuId\":\"72032179\"}

Order

Field

Type

Descript

Sample

orderAmount

Money

Order price

goodsList

List<Goods>

goods infomation

PaySiteUserInfo

Field

Type

Descript

Sample

loginId

String

user login method Id. If user login by 

852-45****88

userId

String

user uuid in AlipayHK

2160120051483575

Goods

Field

Type

Descript

Sample

price

Money

price of goods

quantity

String

quantity of goods

title

String

title of goods

Money

Field

Type

Descript

Sample

amount

Number

currency

String

HKD

Sample

copy
{
            "orderId": "20250306194010800100160900280950024",
            "merchantTransId": "fdy9730943y0egh38eh10sj219sj09r1",
            "createTime": "2024-05-16T14:29:21+08:00",
            "paymentTime": "2024-05-16T14:29:21+08:00",
            "orderStatus": "SUCCESS",
            "order": {
                "orderAmount": {
                    "amount": 1.08,
                    "currency": "HKD"
                },
                "goodsList": [
                    {
                        "price": {
                            "amount": 1.08,
                            "currency": "HKD"
                        },
                        "quantity": "1",
                        "title": "u6D4Bu8BD5u6350u8D60u6807u9898"
                    }
                ]
            },
            "userInfo": {
                "loginId": "852-45****88",
                "userId": "2160120051483575"
            },
                    "extendInfo": "{\"contentId\":\"110123450002\",\"spuId\":\"72032179\"}"
        }

Response

Body

Field

Type

Descript

Sample

result

ResultInfo

ResultInfo

ResultInfo

Field

Type

Descript

Sample

result

ResultInfo

ResultInfo

No

ResultCode

ResultStatus

Remarks

1

SUCCESS

S

Success

2

PROCESS_FAIL

F

General business failure

3

PARAM_ILLEGAL

F

Illegal parameters

4

UNKNOWN_EXCEPTION

U

Unknown exception

Sample

copy
{
  "result": {
    "resultCode": "PROCESS_FAIL",
    "resultStatus": "F",
    "resultMessage": "错误信息"
  }
}