查询结算资金
更新时间:2025.02.20通过此接口可以查询结算资金的明细。
接口说明
适用对象: 直连模式 机构模式
请求URL:https://apihk.mch.weixin.qq.com/pay/settlementquery
请求方式: POST
是否需要证书: 否
请求参数
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
公众账号ID | appid | string(32) | 是 | 微信分配的公众账号ID(企业号corpid即为此appId) |
商户号 | mch_id | string(32) | 是 | 微信支付分配的商户号 |
子商户号 | sub_mch_id | string(32) | 否 | 子商户,填写微信支付分配的商户号
示例值:1230000109 |
结算状态 | usetag | int | 是 | 已结算查询还是未结算查询 |
随机字符串 | nonce_str | string(32) | 是 | 随机字符串,不长于32位。推荐随机数生成算法 |
偏移量 | offset | int | 是 | 返回的查询结果从这个偏移量开始取记录 |
最大记录条数 | limit | int | 是 | 返回的最大记录条数,一般不超过10条为佳。 |
开始日期 | date_start | string(14) | 是 | 格式为yyyyMMdd,如2009年12月25日表示为20091225。时区为GMT+8 beijing(查询未结算记录时,该字段可不传) |
结束日期 | date_end | string(14) | 是 | 格式为yyyyMMdd,如2009年12月25日表示为20091225。时区为GMT+8 beijing(查询未结算记录时,该字段可不传) |
是否查询分账结算信息 | query_split | bool | 否 | 已开通分账权限的商户,若query_split为true,返回信息中会增加分账结算字段;非分账商户无需关注该字段。 |
签名 | sign | string(64) | 是 | 签名,详见签名生成算法 |
举例如下:
返回结果
字段名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string(16) | 是 | SUCCESS/FAIL |
返回信息 | return_msg | string(128) | 是 | 返回信息,如非空,为错误原因 |
以下字段在return_code为SUCCESS的时候有返回
字段名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
公众账号ID | appid | string(32) | 是 | 微信分配的公众账号ID |
商户号 | mch_id | string(32) | 是 | 微信支付分配的商户号 |
随机字符串 | nonce_str | string(32) | 是 | 随机字符串,不长于32位。推荐随机数生成算法 |
业务结果 | result_code | string(16) | 是 | SUCCESS/FAIL |
错误代码 | err_code | string(32) | 否 | 详细参见错误列表 |
错误代码描述 | err_code_des | string(128) | 否 | 结果信息描述 |
返回数据行数 | record_num | string(10) | 是 | 返回数据行数 |
以下字段在return_code 和result_code都为SUCCESS的时候有返回 ,如有多条记录,则以下数据会重复多组
字段名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
付汇批次号 | fbatchno | string(32) | 是 | 微信返回的付款批次号 |
结算日期 | date_settlement | string(14) | 是 | 格式为yyyyMMdd,如2009年12月25日表示为20091225。时区为GMT+8 beijing |
交易开始日期 | date_start | string(14) | 是 | 格式为yyyyMMdd,如2009年12月25日表示为20091225。时区为GMT+8 beijing |
交易结束日期 | date_end | string(14) | 是 | 格式为yyyyMMdd,如2009年12月25日表示为20091225。时区为GMT+8 beijing |
划账金额 | settlement_fee | int | 是 | 外币标价,外币最小单位 |
未划账金额 | unsettlement_fee | int | 是 | 外币标价,外币最小单位 |
结算币种 | settlementfee_type | string(8) | 是 | 标价币种,符合ISO 4217标准的三位字母代码,详见标价币种 |
支付金额 | pay_fee | int | 是 | 该结算周期内会发生结算的交易总金额 |
退款金额 | refund_fee | int | 是 | 该结算周期内退款总金额 |
支付净额 | pay_net_fee | int | 是 | 该结算周期交易与退款总金额之差 |
手续费金额 | poundage_fee | int | 是 | 手续费金额 |
分账划账金额 | split_settlement_fee | int | 否 | 外币标价,外币最小单位。满足[商户开通分账权限]且[query_split=true]且[usetag=1]时,返回该信息 |
分账未划账金额 | split_unsettlement_fee | int | 否 | 外币标价,外币最小单位。满足[商户开通分账权限]且[query_split=true]且[usetag=2]时,返回该信息。 |
举例如下: