API Dictionary / Funds Distribution(Refund) / API for Querying the Real-time Balance Available for Advance Refund

API for Querying the Real-time Balance Available for Advance Refund

Latest update time：2024.01.25 Release notes

If a merchant would like to initiate a refund of the outbound portion of a funds-distribution payment order that is unfrozen, the overseas institutional merchant can use this API to get the current Advance Refund quota.

Tips：

• The quota is based on the unfrozen outbound funds specified by the merchant. Before foreign currency is purchased for the outbound funds on the day, the quota is available for advance payment. By supplementing the gap in funds for the outbound portion of historical order refunds, the quota protects a user's right to a refund. The quota cannot be used for other funds.

1. API Instructions

Applicable to：Common mode Institutional mode

Request URL：https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/refunds/refundable-balance

Request method：GET

Pathparameter is a path parameter.

Queryparameter needs to be passed in the request URL.

Bodyparameter needs to be passed in the request JSON.

2. Request Parameters

No request parameters

Request Eample：

URL


https://api.mch.weixin.qq.com/v3/global/profit-sharing/refunds/refundable-balance


									{
										"stock_id": "PHP",
										"offset": 10,
										"limit": 10,
									}


									{
										"stock_id": ".NET",
										"limit": 10,
									}


									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

3. Return Parameters

Name	Variable Name	Type	Required	Description
Sponsor Merchant ID	sponsor_mchid	string[1, 32]	Yes	A sponsor is a merchant that conducts transactions or transfers in WeChat Pay, and is an overseas institutional merchant. Example：19000000001
Real-time Balance Available for Advance Refund	balance	int	Yes	The real-time balance that is available for advance refund in the smallest unit of currency (currently in CNY Fen). Example：1000
Currency Type	currency	string[3, 3]	Yes	Only the Chinese yuan "CNY" is supported. Example：CNY

Response Example:

SUCCESS


{
  "balance": 1000,
  "currency": "CNY",
  "sponsor_mchid": "19000000001"
}


									{
										"stock_id": "PHP",
										"offset": 10,
										"limit": 10,
									}


									{
										"stock_id": ".NET",
										"limit": 10,
									}


									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

4. Error Codes

Error Codes	Error Message	Description	Solution
400	INVALID_REQUEST	This order does not support ledger splitting	Please check if the WeChat payment order number is filled in incorrectly and confirm that the call to the order API has been successful before executing call to the accounting mark API
403	NO_AUTH	The merchant has not signed up for the overseas funds-distribution function.	See the product process and preparation before access, and check that the merchant has funds-distribution permission before initiating a request.
403	NO_AUTH	The merchant has enabled the funds-distribution function and is waiting for it to take effect. (In most cases, the function will take effect only on the next day.)	You cannot initiate a funds-distribution on the day that you enable the function. Initiate the request on the next day.
403	NO_AUTH	The merchant parent-child relationship does not exist. Initiate the request with the correct Sub-Merchant ID.	Check if the Sub-Merchant ID (sub_mchid) is correct.

Page Navigation

Language

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

Payments

Funding Products

Other Products

API for Querying the Real-time Balance Available for Advance Refund

1. API Instructions

2. Request Parameters

Request Eample：

3. Return Parameters

Response Example:

4. Error Codes