Funds-distribution Mark

Update Time:2025.01.07

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


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.
Note: Only for Institutional 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

Body Price currency of the transaction. Currently only the transactions in "CNY" is supported for funds-distribution.
Example: CNY

Request Example:

Common mode

1{
2  "currency": "CNY",
3  "out_trade_no": "P20150806125346",
4}

Service Provide Mode/Institution Mode

1{
2  "currency": "CNY",
3  "out_trade_no": "P20150806125346",
4  "sub_mchid": "1900000109"
5}

 

3. Response Parameters

 

The request is processed successfully without any response content.

Response Example:

SUCCESS

1    204
2    The request is processed successfully without any response content.

ERROR

1{
2	"code": "SYSTEM_ERROR",
3	"message": "Parameter error"
4}

 

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

 

 

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2025 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global

Contact Us

Customer Service Tel

+86 571 95017

9:00-18:00 Monday-Friday GMT+8

Business Development

wxpayglobal@tencent.com

Developer Support

wepayTS@tencent.com

Wechat Pay Global

About Tenpay
Powered By Tencent & Tenpay Copyright© 2005-2025 Tenpay All Rights Reserved.