Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

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 or institutions, this field is not required
2.For service providers, this field is required
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 int 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 int 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
Name Variable Name Type Required Description
Batch Number batch_id string(32) Yes Batch number by WeChat
Example:20091225003
Settlement Date settlement_date string(8) Yes 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(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(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
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
Example:123
Currency currency string(16) Yes Currency, The three letter code in accordance with ISO 4217
Example:HKD
Payment Amount pay int Yes Priced in foreign currency at the minimum trading unit
Example:123
Refund Amount refund int Yes Priced in foreign currency at the minimum trading unit
Example:123
Net Amount net int Yes Priced in foreign currency at the minimum trading unit
Example:123
Fee fee int Yes Priced in foreign currency at the minimum trading unit
Example:123
Wallet Region wallet_region string(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
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
 }
 
                                

Release notes

close
V1.0
2020.06.24
1. Query Fund Settlement Details API released online

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2019 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

Wechat Pay Global

ICP证

粤B1.B2-20090295