最新更新時間:2020.04.27 版本說明
商戶在交易完結(jié)之后,可按結(jié)算日期查詢已結(jié)算資金明細(sette_state為SETTLED),也可以查詢未結(jié)算資金明細(sette_state為UNSETTLE)。
該接口供跨境收單機構(gòu)/直連商戶使用,特別是,日本/澳門機構(gòu)商戶若開通香港錢包業(yè)務(wù),需要對接該接口。
適用對象:直連模式 機構(gòu)模式
接口URL:https://api.mch.weixin.qq.com/hk/v3/settle/settlements
請求方式:GET
接口規(guī)則:https://wechatpay-api.gitbook.io/wechatpay-api-v3/
path指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
子商戶號 | sub_mchid | string(32) | 否 | path
子商戶,填寫微信支付分配的商戶號 1. 若商戶是直連商戶,無需填寫該字段 2. 若商戶是機構(gòu)/銀行服務(wù)商,無需填寫該字段 示例值:1900000101 |
結(jié)算狀態(tài) | settle_state | string(32) | 是 | path
資金結(jié)算狀態(tài),枚舉值: SETTLED:已結(jié)算 UNSETTLE:未結(jié)算 示例值:SETTLED |
結(jié)算開始日期 | settle_start_date | string(8) | 否 | path
1、格式為yyyyMMdd,如2009年12月25日表示為20091225,時區(qū)為GMT+8 beijing 2、當settle_state(結(jié)算狀態(tài))為SETTLED時,該字段必填;當settle_state(結(jié)算狀態(tài))為unsettle時,該字段無效 示例值:20091225 |
結(jié)算結(jié)束日期 | settle_end_date | string(8) | 否 | path
1、格式為yyyyMMdd,如2009年12月25日表示為20091226,時區(qū)為GMT+8 beijing 2、當settle_state(結(jié)算狀態(tài))=SETTLED時,該字段必填;當settle_state(結(jié)算狀態(tài))=unsettle時,該字段無效 3、結(jié)算結(jié)束日期需大于等于結(jié)算開始日期 示例值:20091226 |
最大記錄條數(shù) | limit | uint32 | 是 | path
返回的最大記錄條數(shù),一般不超過10條為佳,系統(tǒng)最大支持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
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
+ 結(jié)算信息列表 | data | array | 否 | 結(jié)算信息的詳情 |
總記錄條數(shù) | total_count | int | 是 | 資源總條數(shù),當offset=0或者當前查詢?yōu)榭諘r應(yīng)該返回總條數(shù) 示例值:1234 |
記錄起始位置 | offset | int | 是 | 本次查詢的起始位置 示例值:1 |
本次返回條數(shù) | limit | int | 是 | 返回本次查詢到的條數(shù) 示例值: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
}
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證