Asynchronous Notification Signature Generation Process

Asynchronous Notification Parameters Example

Field	Type	Description	Details
`order_id`	String	Order ID	The order ID assigned by YiSiHui.
`pay_result`	Int	Payment Result	`1` for success, `0` for failure.
`pay_amount`	Float	Payment Amount	A floating-point value, e.g., `10000.00`.
`pay_datetime`	String	Payment Time	A string, e.g., `2017-10-12 10:00:00`.
`extend_info`	String	Extended Info	Reserved for future use.
`sign`	String	Signature	Generated using MD5. See the detailed process below.

Signature Generation Process for Asynchronous Notifications

Follow the steps below to generate the signature based on the asynchronous notification parameters:

Parameter Sorting
Exclude the sign field from the parameters. Sort the remaining parameters alphabetically by their key names. If the first letters are the same, compare the second letters, and so on.

String Concatenation
Concatenate the sorted parameters into a single string. Use the & symbol to separate each key-value pair in the format key=value.

Salt Addition (optional)
Add a specified salt value to the beginning of the concatenated string.

MD5 Hashing
Apply the MD5 algorithm to compute the hash of the resulting string from the previous step.

Assign the Signature
Use the computed MD5 hash as the value for the sign field in the notification.

Example for Signature Generation

Suppose the parameters are:

{
    "order_id": "ETxxxxxxxxxxxx01",
    "pay_result": 1,
    "pay_amount": 10000.00,
    "pay_datetime": "2024-12-01 10:00:00",
    "extend_info": ""
}

Sorting & Concatenation:
extend_info=&order_id=ETxxxxxxxxxxxx01&pay_amount=10000.00&pay_datetime=2024-12-01 10:00:00&pay_result=1

Salt Addition (e.g., salt is abc123) (optional):
abc123extend_info=&order_id=ETxxxxxxxxxxxx01&pay_amount=10000.00&pay_datetime=2024-12-01 10:00:00&pay_result=1

MD5 Hashing:
Generate the MD5 hash of the string:
MD5("abc123extend_info=&order_id=ETxxxxxxxxxxxx01&pay_amount=10000.00&pay_datetime=2024-12-01 10:00:00&pay_result=1")

Result
The resulting MD5 hash becomes the value of the sign field.

{
    "order_id": "ETxxxxxxxxxxxx01",
    "pay_result": 1,
    "pay_amount": 10000.00,
    "pay_datetime": "2024-12-01 10:00:00",
    "extend_info": "",
    "sign": "652614570bcc49940d7dcc7a3c3dc7e5"
}

Example: Signature Generation

Python3:

# Python3
import hashlib


def generate_sign(sign_params: dict, salt=None) -> str:
    if not salt:
        salt = ""

    md5_text = str(salt) + "&".join(
        [f"{k}={v}" for k, v in sorted(sign_params.items())]
    )
    return hashlib.md5(bytes(md5_text, encoding="utf-8")).hexdigest()

Asynchronous Notification Signature Generation Process

Asynchronous Notification Parameters Example#

Signature Generation Process for Asynchronous Notifications#

Example for Signature Generation#

Example: Signature Generation#

Asynchronous Notification Parameters Example

Signature Generation Process for Asynchronous Notifications

Example for Signature Generation

Example: Signature Generation