Query Fund Settlement Details
Latest update time：2020.06.24 Release notes
After a transaction has been closed, 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.
API intro
Request Url:https://api.mch.weixin.qq.com/hk/v3/settle/settlements
Request method:GET
API rules: https://wechatpay-api.gitbook.io/wechatpay-api-v3
Applicable object:Common modeInstitutional mode
path Indicates that the parameter is required in the request URL
query Indicates that the parameter is required in the request JSON
Request Parameters
| Name | Variable Name | Type | Required | Description |
|---|---|---|---|---|
| Sub-merchant ID | sub_mchid | String(32) | No | path: The merchant ID assigned by WeChat Pay for the sub-merchant 1.For direct merchants, this field is not required 2.For service providers, enter the sub-merchant ID Example:1900000101 |
| Settlement Status | settle_state | String(32) | Yes | path: Fund settlement status. Enumerated values: SETTLED: Funds are settled UNSETTLE: Funds are not settled Example:SETTLED |
| Settlement Start Date | settle_start_date | String(8) | No | path: 1. Format: yyyyMMdd, such as 20091225 for Dec. 25, 2009. Time zone: GMT+8 Beijing. 2. 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(8) | No | path: 1. Format: yyyyMMdd, such as 20091226 for Dec. 26, 2009. Time zone: GMT+8 Beijing. 2. If settle_state is SETTLED, this field is required. If settle_state is UNSETTLE, this field is invalid. 3. The settlement end data must be later than the settlement start date. Example:20091226 |
| Maximum Count | limit | uint32 | Yes | path: 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 | uint32 | Yes | path: The start position of the requested resources. Example:10 |
Example：
https://api.mch.weixin.qq.com/hk/v3/settle/settlements?sub_mchid=
190000010&settle_state=SETTLED&settle_start_date=20091225&settle_end_date=20091226&offset=10&limit=5
Return Data
Normal return
| Name | Variable Name | Type | Required | Description |
|---|---|---|---|---|
| Settlement Information List | data | array | No | Details of the settlement information |
| 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 |
Example：
"data" : [ {
"trade_end_date" : "20091225",
"amount" : {
"settled" : 123,
"fee" : 123,
"pay" : 123,
"currency" : "HKD",
"net" : 123,
"unsettle" : 123,
"refund" : 123
},
"settlement_date" : "20091225",
"batch_id" : "20091225003",
"wallet_region" : "CHINA_HONGKONG",
"trade_start_date" : "20091225"
}, {
"trade_end_date" : "20091225",
"amount" : {
"settled" : 123,
"fee" : 123,
"pay" : 123,
"currency" : "HKD",
"net" : 123,
"unsettle" : 123,
"refund" : 123
},
"settlement_date" : "20091225",
"batch_id" : "20091225003",
"wallet_region" : "CHINA_HONGKONG",
"trade_start_date" : "20091225"
} ],
"offset" : 1,
"total_count" : 1234,
"limit" : 20
}
-
Customer Service Tel
-
Business Development
-
9:00-18:00
Monday-Friday GMT+8
-
Technical Support
WeChat Pay Global
ICP證