AlipayHKAlipayHKDOCS

4. Send User Transaction Record

POST /{Merchant’s tag}/points/bill/notify

Sample：https://hk-api.merchant.com/merchant/api/alipayhk/points/bill/notify

Fail retry sequence of Alipay: 2m, 10m, 10m, 1h, 2h, 6h, 15h

General Headers

Name

Description

Type

Sample

Client-Id

REQUIRED

An ID provided by AlipayHK, used to identify partner and application system.

String

4Q5Y8W0WSG45P907917

Content-Type

REQUIRED

The RFC 2616 media type of the request body, the charset should be as same as the one used for cryptographic operations. 

String

application/json; charset=UTF-8

Signature

REQUIRED

A key-value pairs string separated by commas (,), which keys and values are joined by equal signs (key=value). 

Valid keys include: 

  • algorithm: The digital signature algorithm used in generating the signature, RSA256 or ECC224, uses RSA256 by default. 
  • keyVersion: The key version of the signing key configured with Client-Id, uses the latest version by default. 
  • signature: The signature value of this request. 

String

algorithm=RSA256, keyVersion=1, signature=KEhXthj4bJ801Hqw8kaLvEKc0Rii8KsNUazw7kZgjxyGSPuOZ48058UVJUkkR21iD9JkHBGR rWiHPae8ZRPuBagh2H3qu7fxY5GxVDWayJUhUYkr9m%2FOW4UQVmXaQ9yn%2Fw2dCtzwAW0htPHYrKMyrT pMk%2BfDDmRflA%2FAMJhQ71yeyhufIA2PCJV8%2FCMOa46303A0WHhH0YPJ9%2FI0UeLVMWlJ1XcBo3Jr bRFvcowQwt0lP1XkoPmSLGpBevDE8%2FQ9WnxjPNDfrHnKgV2fp0hpMKVXNM%2BrLHNyMv3MkHg9iTMOD% 2FFYDAwSd%2B6%2FEOFo9UbdlKcmodJwjKlQoxZZIzmF8w%3D%3D

Encrypt

REQUIRED when message content needs to be encrypted. 

A key-value pairs string separated by commas (,), which keys and values are joined by equal signs (key=value). 

Valid keys include: 

  • algorithm: The symmetric key algorithm used in encryptingthe signature, only RSA_AES is supported. 
  • keyVersion: The key version of the signing key configured with Client-Id, uses the latest version by default.
  • symmetricKey: The encrypted symmetric key.

String

algorithm=RSA, keyVersion=1, symmetricKey=bqS8HSmdaRrpKSuPy7CqUlyd8lJurG93

Request-only Headers

Name

Description

Type

Sample

Request-Time

REQUIRED

The ISO-8601 datetime of this API request with timezone.

String

2024-05-22T06:42:21+05:30

Response-only Headers

Name

Description

Type

Sample

Response-Time

REQUIRED

The ISO-8601 datetime of this API response with timezone.

String

2024-05-22T06:42:21+05:30

Tracer-Id

An ID for tracing this request.

String

abcdefg135202000000000263818

Request parameters

userId string  REQUIRED

Unique user ID of Alipay user, either starts with 2160 for AlipayHK or 2088 for AlipayCN.

billNo string  REQUIRED

Transaction ID of AlipayHK.

cnBillNo string  

Transaction ID of AlipayCN.

merchantId string  

ID of the merchant.

merchantName string  

Name of the merchant.

orderAmount OrderAmount  REQUIRED

An object indicates the order amount.

Show child parameters

payTime string  REQUIRED

Time of payment.

pointsProvider string  REQUIRED

Auto earn service provider.

Valid values:

  • ​​ALIPAYHK​
  • ​ALIPAYCN​

outBillNo string  

Transaction ID of the acquirer.

pmsLabel string  

Unique ID assigned by Alipay to identify the PMS combination.

Response parameters

result Result  REQUIRED

A metadata object indicates the result of the request.

Show child parameters
API Explorer

Request

Request Body

Response

Response Body

Result/Error codes

CodeValueMessage
SUCCESSSSuccess
PARAM_ILLEGALFPlease check the parameters of request.
UNKNOWN_EXCEPTIONUAPI failed due to unknown reason, please check with support.
ACCESSTOKEN_VALIDATE_FAILEDFFail to validate access token.