Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

查询结算资金明细API

最新更新时间:2022.03.02 版本说明


商户在交易完结之后,可按结算日期查询已结算资金明细(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 指该参数为URL参数

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

请求参数

参数名 变量 类型 必填 描述
子商户号 sub_mchid string(32) query 子商户,填写微信支付分配的商户号
1. 若商户是直连商户、机构/银行服务商,无需填写该字段
2. 若商户是普通服务商商户,需要填写该字段
示例值:1900000101
结算状态 settle_state string(32) query 资金结算状态,枚举值:
SETTLED:已结算
UNSETTLE:未结算
示例值:SETTLED
结算开始日期 settle_start_date string(8) query 1、格式为yyyyMMdd,如2009年12月25日表示为20091225,时区为GMT+8 beijing
2、当settle_state(结算状态)为SETTLED时,该字段必填;
示例值:20091225
结算结束日期 settle_end_date string(8) query 1、格式为yyyyMMdd,如2009年12月25日表示为20091226,时区为GMT+8 beijing
2、当settle_state(结算状态)=SETTLED时,该字段必填;
3、结算结束日期需大于等于结算开始日期
示例值:20091226
最大记录条数 limit uint32 query 返回的最大记录条数,一般不超过10条为佳,系统最大支持30条
示例值:5
记录起始位置 offset uint32 query 该次请求资源的起始位置
示例值: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[1,32] 微信返回的付款批次号
示例值:20091225003
结算日期 settlement_date string[1,8] 格式为yyyyMMdd,如2009年12月25日表示为20091225。时区为GMT+8 beijing
示例值:20091225
交易开始日期 trade_start_date string[1,8] 格式为yyyyMMdd,如2009年12月25日表示为20091226。时区为GMT+8 beijing
示例值:20091225
交易结束日期 trade_end_date string[1,8] 格式为yyyyMMdd,如2009年12月25日表示为20091225。时区为GMT+8 beijing
示例值:20091225
+ 金额 amount object 指未特殊标记为分账类的普通跨境收单交易。
参数名 变量 类型[长度限制] 必填 描述
已结算金额 settled int 交易开始日期到交易结束日期 已结算金额汇总,币种最小单位
示例值:123
未结算金额 unsettle int 交易开始日期到交易结束日期 未结算金额汇总,币种最小单位
( 按日汇总结算,退款金额大于支付金额 此值可能为负值 计算公式:未结算金额 = 支付金额 - 退款金额 - 手续费金额)
示例值:123
结算币种 currency string[3, 3] 币种,符合ISO 4217标准的三位字母代码
示例值:HKD
支付金额 pay int 交易开始日期到交易结束日期 支付总金额 币种最小单位
示例值:123
退款金额 refund int 交易开始日期到交易结束日期 退款总金额 币种最小单位
示例值:123
支付净额 net int 交易开始日期到交易结束日期 支付净额(支付-退款) 币种最小单位
( 按日汇总结算,退款金额大于支付金额 此值可能为负值 计算公式:支付净额 = 支付金额 - 退款金额)
示例值:123
手续费金额 fee int 交易开始日期到交易结束日期 手续费总金额 币种最小单位
( 按日汇总结算,退款金额大于支付金额 此值可能为负值)
示例值:123
钱包主体 wallet_region string 日本/中国澳门区域已经开通微信香港钱包的跨境收单商户,该字段取值如下:
CHINA_MAINLAND:中国大陆钱包
CHINA_HONGKONG:中国香港钱包
其他场景的商户不返回该字段。
示例值:CHINA_HONGKONG
+ 分账业务金额 split_amount object 指已标记为分账类的跨境收单交易,适用于开通分账功能的业务场景。微信支付平台仅针对特定行业开放分账能力(如跨境电商行业),具体以平台对外公布的产品信息为准。
参数名 变量 类型[长度限制] 必填 描述
已结算金额 settled int 交易开始日期到交易结束日期 已结算金额汇总 币种最小单位
示例值:123
未结算金额 unsettle int 交易开始日期到交易结束日期 未结算金额汇总 币种最小单位
( 按日汇总结算,退款金额大于支付金额 此值可能为负值 计算公式:未结算金额 = 支付金额 - 退款金额 - 手续费金额)
示例值:123
结算币种 currency string[3, 3] 币种,符合ISO 4217标准的三位字母代码
示例值:HKD
支付金额 pay int 交易开始日期到交易结束日期 支付总金额 币种最小单位
示例值:123
退款金额 refund int 交易开始日期到交易结束日期 退款总金额 币种最小单位
示例值:123
总记录条数 total_count int 资源总条数。当offset=0或者当前查询为空时应该返回总条数
示例值:1234
记录起始位置 offset int
示例值:1
本次返回条数 limit int
示例值:20

返回示例


{
  "data": [
    {
      "amount": {
        "currency": "HKD",
        "fee": 123,
        "net": 123,
        "pay": 123,
        "refund": 123,
        "settled": 123,
        "unsettle": 123
      },
      "batch_id": "20091225003",
      "settlement_date": "20091225",
      "split_amount": {
        "currency": "HKD",
        "pay": 123,
        "refund": 123,
        "settled": 123,
        "unsettle": 123
      },
      "trade_end_date": "20091225",
      "trade_start_date": "20091225",
      "wallet_region": "CHINA_HONGKONG"
    }
  ],
  "limit": 20,
  "offset": 1,
  "total_count": 1234
}
                    

http://2323weixin.qq.com
                    

版本说明

关闭
V1.1
2022年3月2日
1. 返回参数新增字段:split_amount(分账业务金额)
V1.0
2020年4月27日
1. 查询结算资金明细API上线

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2022 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global