Synchronize Order

2025-07-23 04:04

POST /api/open/alipay/v1/merchant/order/sync

AlipayHK informs merchants of the order information users purchase via this interface.

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_AES,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

requestId string REQUIRED

An unique request ID (uuid) to identify this API request.

merchantId string

The unique ID of merchant for the order.

It needs to be passed if it is sold by an agent.

tradeNo string REQUIRED

Alipay trade number.

merchantBizNo string REQUIRED

Order number in merchant end.

merchantBizType string REQUIRED

TRADE_ORDER

amount object

The amount of the order

Show child parameters

payAmount object

The amount of the order

Show child parameters

discountAmount object

The amount of the order

Show child parameters

orderStatus string REQUIRED

Order status in merchant end

orderCreateTime number REQUIRED

Creation timestamp of first business event occurrence timestamp, should be consistent.

orderModifyTime number REQUIRED

Business event occurrence timestamp

Tips:

This field is used for idempotency processing. The request will be processed only if the last time the request was processed is earlier than orderModifyTime of the new request.

userId string

ID of AlipayHK user.

For keys 「openId」 & 「userId」, one of them must have content

openId string

ID of AlipayHK user.

For keys 「openId」 & 「userId」, one of them must have content

newFieldjrPOUb

extInfo object REQUIRED

Show child parameters

Response parameters

result Result REQUIRED

A metadata object indicates the result of the request.

Show child parameters

orderId string REQUIRED

The order ID generate by AlipayHK

API Explorer

Request

Request Body

Response

Response Body

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	success	success
UNKNOWN_EXCEPTION	U	Unknown error. Merchants can try later first & contact with AlipayHK