最新更新时间:2020.1.08 版本说明
商户可以通过该接口下载历史交易清单。比如掉单、系统错误等导致商户侧和微信侧数据不一致,通过对账单核对后可校正支付状态。
特别说明:
● 账单完整性校验:账单完整下载后,生成SHA1签名与微信返回HTTP头的Wechatpay-Statement-Sha1值做对比校验。
● 账单压缩:如需对账单进行压缩,要求请求通过HTTP头Accept-Encoding设置为gzip。
适用对象:直连模式机构模式
请求URL: https://api.mch.weixin.qq.com/hk/v3/statements
请求方式: GET
接口规则: https://wechatpay-api.gitbook.io/wechatpay-api-v3/wei-xin-zhi-fu-api-v3-jie-kou-gui-fan
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
账单日期 | date | string(8) | 是 | query 账单日期,格式:20180103 示例值:20180130 |
商户号 | mchid | string(32) | 否 | query 微信支付分配的商户号 示例值:1900000109 |
https://api.mch.weixin.qq.com/hk/v3/statements?date=20180130&mchid=1900000109
成功时,数据以文本表格的方式返回,第一行为表头,后面各行为对应的字段内容,字段内容跟查询订单或退款结果一致,具体字段说明可查阅相应接口。
1)第一行为表头,目前有:交易时间,公众账号ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,充值券币种,充值券金额,优惠券币种,优惠券金额,微信退款单号,商户退款单号,退款类型,退款状态,商品名称,商户数据包,手续费,费率,标价币种,订单金额(标价币种),用户支付币种,用户支付金额,结算币种,应结订单金额,支付汇率,退款汇率,申请退款金额,用户退款币种,用户退款金额,退款结算币种,退款应结订单金额,充值券退款金额,优惠券退款金额。
2)从第二行起,为数据记录,各参数以逗号分隔,参数前增加`符号,为标准键盘1左边键的字符,字段顺序与表头一致。
参数名 | 变量 | 类型 | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | code | string(32) | 是 | 错误码,枚举值见错误码列表 示例值:INVALID_REQUEST |
返回信息 | message | string(256) | 是 | 返回信息,如非空,为错误原因 示例值:参数格式校验错误 |
+ 详细的错误描述 | detail | object | 否 | 当code为PARAM_ERROR时返回,详细说明见下 |
{
"code" : " NO_STATEMENT_EXIST",
"message" : "账单不存在"
}
首先从应答中获取HTTP头Wechatpay-Nonce中的应答随机串,Wechatpay-Timestamp中的应答时间戳,Wechatpay-Statement-Sha1中取得账单SHA1值。
请按照以下规则构造应答的签名串。\n为换行符(ASCII编码值为0x0A)。
应答时间戳\n
应答随机串\n
账单SHA1\n
\n
则签名串为:
1507709906
5K8264ILTKch16CQ2502SI8ZNMTM67VS
{"sha1" : "12345678999"}
注意:标红的sha1值特殊处理为json格式进行签名;签名串最后一行为空,即多一个换行符
微信支付应答签名通过HTTP头Wechat-Signature传递。(注意,示例因为排版可能存在换行,实际数据应在一行)
Wechatpay-Signature: WcO+t3D8Kg71dTlKwN7r9PzUOXeaBJwp8/FOuSxcuSkXsoVYxBpsAidprySCjHCjmaglNcjoKJQLJ28/Asl93jo
TW39FX6i07lXhnbPknezAlwmvPdnQuI01HZsZF9V1i6ggZjBiAd5lG8bZtTxZOJ87ub2i9GuJ3Nr/NUc9VeY=,对Wechatpay-Signature的字段值使用Base64进行解码,得到应答签名。
很多编程语言的签名验证函数支持对“签名数据”进行签名验证。建议商户调用该类函数,使用微信支付平台公钥对“签名串”进行SHA256 with RSA签名验证。
如果商户使用的编程语言或者库只支持对“摘要数据”进行签名验证,请按照以下步骤验证签名:
1.使用SHA256计算签名串的摘要,得到摘要信息
2.使用微信支付平台公钥对摘要信息进行RSA签名验证(签名类型为SHA256)。请参考OpenSSL的RSA_verify()
注意:微信支付证书序列号位于HTTP头`Wechatpay-Serial`,验证签名前请先检查序列号是否跟商户所持有的微信支付证书序列号一致。更新证书的说明,请参考《获取微信支付平台证书》。
账单完整下载后,生成SHA1签名与微信Wechatpay-Statement-Sha1值做账单完整性的校验。
错误码 | 描述 | 解决方案 |
---|---|---|
SYSTEM_ERROR | 微信支付内部错误 | 请稍后重试 |
PARAM_ERROR | 参数错误 | 请对照文档的请求参数说明检查参数 |
NO_STATEMENT_EXIST | 账单不存在 | 请检查当前商户号的微信账户在指定日期内是否有资金变动。 |
BILL_CREATING | 账单生成中 | 请先检查当前商户号在指定日期内是否有成功的交易,如指定日期有交易则表示账单正在生成中,请在上午10点以后再下载。 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证