最新更新时间: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
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
+ 结算信息列表 | data | array | 是 | 结算信息的详情 |
总记录条数 | 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
}
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证