WeChat Pay Open Platform

Return Home / Cross-border Funds-Distribution / Funds-distribution Mark API

Funds-distribution Mark API

Latest update time：2022.05.18 Release notes

Before 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.

Tips：

● This API is available to cross-border acquiring institutions/direct merchants. Particularly, Japanese/Macau institutions that have activated Hong Kong Wallet should use this API.

● The API parameters must be consistent with those of the merchant order-placing interface (sub-merchant ID, transaction ID and currency). Otherwise, the funds-distribution mark will be invalid.

● The funds freezing process for the transaction marked with "funds-distribution" will be enabled after the payment is completed. It is recommended that the merchant confirm whether the transaction funds can be distributed through [Remaining Funds Amount to be Distributed Query API] after 3~5 mins
(Note: When the transaction funds can be distributed,the current remaining funds amount to be distributed will be returned. When the transaction funds cannot be distributed, an error prompt will be returned).

API Intro

Request Url:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/transactions/mark

Request method:POST

API rules: https://wechatpay-api.gitbook.io/wechatpay-api-v3

Applicable object:Common modeInstitutional mode

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.

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. Note: Only forInstitutional mode Example:1900000109
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. Example:P20150806125346
Price currency	currency	string[1, 10]	Yes	bodyPrice currency of the transaction. Currently only the transactions in "CNY" is supported for funds-distribution. Example:CNY

Example：

{
  "currency": "CNY",
  "out_trade_no": "P20150806125346",
}

{
  "currency": "CNY",
  "out_trade_no": "P20150806125346",
  "sub_mchid": "1900000109"
}

Return Data

The request is processed successfully without any response content.

Example：


204
The request is processed successfully without any response content.

{
"code":"SYSTEM_ERROR",
"message":"Parameter error"
}

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
		Receiver	Confirm that the receiver is legally compliant before requesting funds-distribution
		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

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

Cross-border Funds-Distribution API

Funds-distribution Mark API

Tips：

API Intro

Request Parameters

Example：

Return Data

Example：

Error Codes

Release notes