微信支付境外文档-结算资金查询

返回上一层结算资金查询对外 / 查询结算资金明细API

查询结算资金明细API

最新更新时间：2020.04.27 版本说明

商户在交易完结之后，可按结算日期查询已结算资金明细（sette_state为SETTLED），也可以查询未结算资金明细（sette_state为UNSETTLE）。

注意：

该接口供跨境收单机构/直连商户使用，特别是，日本/澳门机构商户若开通香港钱包业务，需要对接该接口。

接口说明

适用对象：直连模式机构模式

接口URL：https://api.mch.weixin.qq.com/hk/v3/settle/settlements

请求方式：GET

接口规则：https://wechatpay-api.gitbook.io/wechatpay-api-v3/

path指该参数为路径参数

query 指该参数需在请求JSON传参

请求参数

参数名	变量	类型	必填	描述
子商户号	sub_mchid	string（32）	否	path 子商户，填写微信支付分配的商户号 1. 若商户是直连商户，无需填写该字段 2. 若商户是机构/银行服务商，无需填写该字段示例值：1900000101
结算状态	settle_state	string（32）	是	path 资金结算状态，枚举值： SETTLED：已结算 UNSETTLE：未结算示例值：SETTLED
结算开始日期	settle_start_date	string（8）	否	path 1、格式为yyyyMMdd，如2009年12月25日表示为20091225，时区为GMT+8 beijing 2、当settle_state（结算状态）为SETTLED时，该字段必填；当settle_state（结算状态）为unsettle时，该字段无效示例值：20091225
结算结束日期	settle_end_date	string（8）	否	path 1、格式为yyyyMMdd，如2009年12月25日表示为20091226，时区为GMT+8 beijing 2、当settle_state（结算状态）=SETTLED时，该字段必填；当settle_state（结算状态）=unsettle时，该字段无效 3、结算结束日期需大于等于结算开始日期示例值：20091226
最大记录条数	limit	uint32	是	path 返回的最大记录条数，一般不超过10条为佳，系统最大支持30条示例值：5
记录起始位置	offset	uint32	是	path 该次请求资源的起始位置示例值：10

请求示例：


 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

    
｛
JAVA示例代码
｝

返回参数

正常返回

参数名

变量

类型

必填

描述

+ 结算信息列表

data

array

否

结算信息的详情

参数名

变量

类型

必填

描述

付款批次号

batch_id

string（32）

是

微信返回的付款批次号
示例值：20091225003

结算日期

settlement_date

string（8）

是

格式为yyyyMMdd，如2009年12月25日表示为20091225。时区为GMT+8 beijing
示例值：20091225

交易开始日期

trade_start_date

string（8）

是

格式为yyyyMMdd，如2009年12月25日表示为20091226。时区为GMT+8 beijing
示例值：20091225

交易结束日期

trade_end_date

string（8）

是

格式为yyyyMMdd，如2009年12月25日表示为20091225。时区为GMT+8 beijing
示例值：20091225

+ 金额

amount

object

是

结算金额信息

参数名	变量	类型	必填	描述
已结算金额	settled	int	是	交易开始日期到交易结束日期已结算金额汇总，外币标价，外币最小单位示例值：123
未结算金额	unsettle	int	是	交易开始日期到交易结束日期未结算金额汇总，外币标价，外币最小单位示例值：123
结算币种	currency	string（32）	是	币种，符合ISO 4217标准的三位字母代码示例值：HKD
支付金额	pay	int	是	交易开始日期到交易结束日期支付总金额，外币标价，外币最小单位示例值：123
退款金额	refund	int	是	交易开始日期到交易结束日期退款总金额，外币标价，外币最小单位示例值：123
支付净额	net	int	是	交易开始日期到交易结束日期支付净额（支付-退款），外币标价，外币最小单位示例值：5
手续费金额	fee	int	是	交易开始日期到交易结束日期手续费总金额，外币标价，外币最小单位示例值：5

钱包主体

wallet_region

string（32）

否

日本/中国澳门区域已经开通微信香港钱包的跨境收单商户，该字段取值如下：
CHINA_MAINLAND：中国大陆钱包
CHINA_HONGKONG：中国香港钱包
其他场景的商户不返回该字段。示例值：CHINA_HONGKONG

总记录条数

total_count

int

是

资源总条数，当offset=0或者当前查询为空时应该返回总条数
示例值：1234

记录起始位置

offset

int

是

本次查询的起始位置
示例值：1

本次返回条数

limit

int

是

返回本次查询到的条数
示例值：20

返回示例：

正常示例

{
	"data" :  [ {    
		"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",
		    "trade_end_date" :   "20091225"  
	} ],
	  "offset" :  1,
	  "total_count" :  1234,
	  "limit" :  20
}

错误码

状态码	错误码	描述	解决方案
500	SYSTEM_ERROR	系统错误	系统错误，请稍后再试
400	PARAM_ERROR	参数错误	参数错误，请核对参数后重试
429	FREQUENCY_LIMITED	请求频率过高	请求频率过高，请稍后重试
404	RESOURCE_NOT_EXISTS	记录不存在	记录不存在，请调整参数后重试

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

结算资金查询对外 API

查询结算资金明细API

注意：

接口说明

请求参数

请求示例：

返回参数

正常返回

返回示例：

错误码

版本说明