Weixin Pay Open Platform

Return Home / Cross-border Funds-Distribution / Remaining Funds Amount to be Distributed Query API

Remaining Funds Amount to be Distributed Query API

Latest update time：2022.05.18 Release notes

Call API to query the transaction's remaining funds amount to be distributed.

Request Url:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/transactions/{transaction_id}/amounts

Request method:GET

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.

Name	Variable Name	Type	Required	Description
Sub-merchant ID	sub_mchid	string[1, 32]	No	query Sub-merchant ID allocated by Weixin Pay. It needs to be consistent with the sub-merchant ID in the transaction of Weixin Pay. Note: Only forInstitutional mode Example:1900000109
Weixin Pay transaction ID	transaction_id	string[1, 32]	Yes	path?Weixin Pay transaction ID Example:4208450740201411110007820472

https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/transactions/4208450740201411110007820472/amounts?sub_mchid=1900000109

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

Name	Variable Name	Type	Required	Description
Weixin Pay order No.	transaction_id	string[1, 32]	Yes	Weixin Pay transaction ID Example:4208450740201411110007820472
Remaining funds amount to be distributed	unsplit_amount	int	Yes	Remaining funds amount to be distributed, in the minimum unit of currency. (CNY Currently, unit: cents). Example:1000
Currency type	currency	string[1, 10]	Yes	Only CNY is supported currently. Example: CNY


{
  "currency": "CNY",
  "transaction_id": "4208450740201411110007820472",
  "unsplit_amount": 1000
}

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

Error Codes	Error Message	Description	Solution
400	INVALID_REQUEST	The merchant information is inconsistent with that in the original command	Check whether the out_order_no/transaction_id is filled in correctly
400	INVALID_REQUEST	The WeChat Pay transaction ID is inconsistent with that in the original command	Check whether the out_order_no/transaction_id is filled in correctly
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
403	NO_AUTH	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
403	NO_AUTH	Receiver	Confirm that the receiver is legally compliant before requesting funds-distribution
403	NO_AUTH	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
500	SYSYTEMERROR	The freeze process of the transaction funds specified by the merchant when initiating funds-distribution request has not been completed. Try again later	After the user completes the payment, the fund freezing process for the transaction with funds-distribution will be triggered. It is recommended that the merchant try again after 3~5 mins