The merchant can query the details of both settled funds (sette_state is SETTLED) and unsettled funds (sette_state is UNSETTLE) by settlement date.
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.
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
Query The merchant ID assigned by WeChat Pay for the sub-merchant 1.For direct merchants or institutions, this field is not required 2.For service providers, this field is required Example: 1900000101
Settlement Status
settle_state
string[1,32]
Yes
Query Fund settlement status. Enumerated values: SETTLED: Funds are settled UNSETTLE: Funds are not settled Example: SETTLED
Settlement Start Date
settle_start_date
string[1,8]
No
Query
Format: yyyyMMdd, such as 20091225 for Dec. 25, 2009. Time zone: GMT+8 Beijing.
If settle_state is SETTLED, this field is required. If settle_state is UNSETTLE, this field is invalid.
Example: 20091225
Settlement End Date
settle_end_date
string[1,8]
No
Query
Format: yyyyMMdd, such as 20091226 for Dec. 26, 2009. Time zone: GMT+8 Beijing.
If settle_state is SETTLED, this field is required. If settle_state is UNSETTLE, this field is invalid.
The settlement end data must be later than the settlement start date.
Example: 20091226
Maximum Count
limit
int
Yes
Query The maximum number of records returned, which is preferably 10 or less. The system supports up to 30 records. Example: 5
Start Position of Record
offset
int
Yes
Query The start position of the requested resources. Example: 10
The format is yyyymmdd, for example, December 25, 2009 is 20091225, and the time zone is GMT + 8 Beijing Example: 20091225
Trade Start Date
trade_start_date
string[1,8]
Yes
The format is yyyymmdd, for example, December 25, 2009 is 20091225, and the time zone is GMT + 8 Beijing Example: 20091225
Trade End Date
trade_end_date
string[1,8]
Yes
The format is yyyymmdd, for example, December 25, 2009 is 20091225, and the time zone is GMT + 8 Beijing Example: 20091225
Amount
amount
object
Yes
settlement amount
Amount
Name
Variable Name
Type
Required
Description
Settled Amount
settled
int
Yes
Priced in foreign currency at the minimum trading unit Example: 123
Unsettle Amount
unsettle
int
Yes
Priced in foreign currency at the minimum trading unit amount is summarized for settlement by day. When the refund amount is greater than the payment amount, this value may be negative. Calculation formula: Unsettled amount = Payment amount - Refund amount - Handling fee amount. Example: 123
Currency
currency
string[1,16]
Yes
Currency, The three letter code in accordance with ISO 4217 Example: HKD
Net Amount
net
int
Yes
Priced in foreign currency at the minimum trading unit amount may be negative. (The amount is summarized for settlement by day. When the refund amount is greater than the payment amount, this value may be negative. Calculation formula: Net payment = Payment amount - Refund amount) Example: 123
Fee
fee
int
Yes
Priced in foreign currency at the minimum trading unit amount may be negative. (The amount is summarized for settlement by day. When the refund amount is greater than the payment amount, this value may be negative. ) Example: 123
Wallet Region
wallet_region
string[1,32]
No
For overseas merchants who have opened WeChat Hong Kong wallet in Japan/Macao(China), the values of this field are as follows:， CHINA_MAINLAND CHINA_HONGKONG Note: Merchants in other scenarios do not return this field Example: CHINA_HONGKONG
Amount of Funds-distribution
split_amount
object
No
Refers to the cross-border acquisition transactions marked as the funds-distribution type, applicable to business scenarios where the funds-distribution function is enabled. The WeChat Pay platform only enables the funds-distribution capability for specific industries (such as the cross-border e-commerce industry) only, subject to the product information published by the platform.
Amount of Funds-distribution
Name
Variable Name
Type
Required
Description
Settled Amount
settled
int
Yes
Transaction Start Date to Transaction End Date Summary of Settled Amount Minimum Unit of Currency
Example: 123
Unsettled Amount
unsettle
int
Yes
Transaction Start Date to Transaction End Date Summary of Unsettled Amount Minimum Unit of Currency
(For summarizing and settling by day, if the refund amount is greater than the payment amount, this value may be negative. Calculation formula: Unsettled Amount = Payment Amount - Refund Amount - Service Fee Amount) Example: 123
Settlement Currency
currency
string[3, 3]
Yes
Currency, a three letter code in compliance with the ISO 4217 standard
Example: HKD
Payment Amount
pay
int
Yes
Transaction Start Date to Transaction End Date Total Payment Amount Minimum Unit of Currency
Example: 123
Refund Amount
refund
int
Yes
Transaction Start Date to Transaction End Date Total Refund Amount Minimum Unit of Currency
Example: 123
Total Count
total_count
int
Yes
Total number of resources. If offset is 0 or no record is found for this query, this parameter is returned. Example: 123
Start Position of Record
offset
int
Yes
The start position of the resources for this query Example: 1
Records Returned
limit
int
Yes
The number of records found for this query is returned. Example: 20
