2. Send User Transaction Record
Fail retry times:7 times
Retry Interval:2m,10m,10m,1h,2h,6h,15h
API Path
/{Merchant’s tag}/points/bill/notify
Sample: https://hk-api.merchant.com/merchant/api/alipayhk/points/bill/notify
API Request
Request
Header
Name | Description | Type | Length | Required | Remarks | Sample |
client-id | Client ID | String | M |
| 211020000000000000044 | |
signature | Message signature information | String | M |
| algorithm=RSA256,keyVersion=2,signature=xxxxxxxxxxxyyyyyyyyyyyyyyzzzzzzzzz== | |
encrypt | Message encryption information | String | O | algorithm=rsa, keyVersion=2 | ||
Content-type | HTTP content type | String | M | application/json; charset=UTF-8 | ||
request-time | Request time | String | M | 2023-12-18T02:33:31Z |
Body
Field | Type | Required | Description | Sample |
userId | String | M | Unique Id to identify an Alipay user | AlipayHK user: 21601234567890 AlipayCN user: 208801234567890 |
billNo | String | M | AlipayHK transaction ID | |
cnBillNo | String | O | AlipayCN transaction ID | |
merchantId | String | O | Merchant ID | 21609876543945 |
merchantName | String | O | Merchant Name | Openrice |
orderAmount | JSON | M | Order amount, unit:cent | 1800 |
payTime | String | M | Time of payment | |
pointsProvider | String | M | Auto earn service provider | ALIPAYHK or ALIPAYCN |
outBillNo | String | O | Transaction ID provided by Acquirer | |
pmsLabel | String | O | Uniquely represent the payment PMS |
orderAmount
Field | Type | Required | Description | Sample |
currency | String | M | Order currency | HKD |
value | Integer | M | Amount, The smallest unit of a specified currency. eg. When the currency is USD, the unit of value is cents; when the currency is Japanese yen, the unit of value is Japanese yen. | 1800 |
Response
Header
Name | Description | Type | Required | Sample |
client-id | String | M | Client ID | |
signature | String | M | Message signature information | |
encrypt | String | O | Message encryption information | |
Content-type | String | M | Http content type | |
response-time | String | M | response time | 2019-07-12T12:08:56+00:00 |
Body
Field | Type | Required | Sample |
result | The result of this call, reflecting the business status and error information of this call | Result |
Result
Field | Type | Required | Description |
resultCode | String | M | Result code |
resultStatus | String | M | Result status |
resultMessage | String | O | Result message |
Result Code
resultCode | resultMessage | resultStatus |
SUCCESS | success | S |
PARAM_ILLEGAL | Illegal parameters. For example, non-numeric input, invalid date. | F |
UNKNOWN_EXCEPTION | Unknown exception | U |
3. Request Example
Request
{
"userId": "2160220043038272",
"billNo": "20230320194010800100160270205544801",
"cnBillNo": "2023071422001454501409397849",
"merchantId": "2088201919015172",
"merchantName": "Apple Store",
"pointsProvider": "ALIPAYHK",
"orderAmount": {
"currency": "HKD",
"value": 1211
},
"payTime": "2023-04-01 17:45:56"
"outBillNo":"HKdailytest_1679466315224",
"pmsLabel":"2023032419161407000004300008719"
}
Response
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success.",
"resultStatus": "S"
}