Funds-distribution Mark
Update Time:2025.01.07Before a merchant transaction, call the API to mark it with "funds-distribution", indicating that the transaction will subsequently be subject to the funds-distribution function. After the payment is completed, the transaction funds will be frozen in the merchant's account, waiting for the funds-distribution command or unfreeze remaining funds command from the merchant to distribute the funds.
|
1. API Intro
Applicable object: Common mode Institutional mode
API rules:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/transactions/mark
Request method:POST
Path parameter is a path parameter.
Query parameter needs to be passed in the request URL.
Body parameter needs to be passed in the request JSON.
2. Request Parameters
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
Sub-merchant ID | sub_mchid | string[1, 32] | No | Body Sub-merchant ID allocated by WeChat Pay. It needs to be consistent with the sub-merchant ID in the transaction of WeChat Pay. |
Transaction ID | out_trade_no | string[6, 32] | Yes | Body Transaction ID to be marked, which needs to be consistent with the transaction ID in the transaction parameters. |
Price currency | currency | string[1, 10] | Yes | Body Price currency of the transaction. Currently only the transactions in "CNY" is supported for funds-distribution. |
Request Example:
Common mode
Service Provide Mode/Institution Mode
3. Response Parameters
The request is processed successfully without any response content.
Response Example:
SUCCESS
ERROR
4. Error Codes
Error Codes | Error Message | Description | Solution |
---|---|---|---|
400 | INVALID_REQUEST | Currently, only CNY is supported for transactions requiring funds-distribution | Modify currency to CNY and call the API again |
400 | INVALID_REQUEST | The transaction has been confirmed and the funds cannot be distributed. Please call the funds-distribution mark API before the transaction. | Refer to the access guidelines and call the API according to the transaction process |
403 | NO_AUTH | The merchant has not signed the overseas funds-distribution product | Refer to the product process and access preparation, confirm that the merchant has funds-distribution authorization, and initiate the request again |
The merchant has enabled the funds-distribution product and is waiting for it to take effect (Usually takes effect the next day) | The funds-distribution function cannot be initiated on the first day. Please initiate the request on the next day | ||
The parent-child relationship of the merchant does not exist. Please use correct sub-merchant ID to initiate the request | Please check if the sub-merchant ID (sub_mchid) is filled in correctly |