按日下载提现异常文件API

电商服务商按日查询并下载提现状态为异常的提现单, 提现异常包括提现失败和银行退票。

接口说明

适用对象: 电商平台
请求 URL: https://api.mch.weixin.qq.com/v3/merchant/fund/withdraw/bill-type/{bill_type}
请求方式: GET
接口规则: https://wechatpay-api.gitbook.io/wechatpay-api-v3

path 指该参数需在请求 URL 传参
query 指该参数需在请求 JSON 传参

请求参数

变量类型必填参数名/描述/示例值
bill_typestring(8)path 账单类型 NO_SUCC: 提现异常账单, 包括提现失败和提现退票账单。
NO_SUCC
bill_datestring(10)path 账单日期 表示所在日期的提现账单, 格式为 YYYY-MM-DD。
例如: 2008-01-01 日发起的提现, 2008-01-03 日银行返回提现失败, 则该提现数据将出现在 bill_date 为 2008-01-03 日的账单中。
2019-08-17
tar_typeenumpath 压缩格式 不填则默认是数据流
枚举值:
GZIP: 返回格式为.gzip 的压缩包账单
GZIP

请求示例

URL https://api.mch.weixin.qq.com/v3/merchant/fund/withdraw/bill-type/NO_SUCC?bill_date=2019-08-17&tar_type=GZIP

返回参数

变量类型必填参数名/描述/示例值
hash_typestring(32)从 download_url 哈希类型 下载的文件的哈希类型, 用于校验文件的完整性。
SHA1
hash_valuestring(1024)从 download_url 哈希值 下载的文件的哈希值, 用于校验文件的完整性。
79bb0f45fc4c42234a918000b2668d689e2bde04
download_urlstring(2048)账单下载地址 供下一步请求账单文件的下载地址, 该地址 30s 内有效。
https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx

返回示例

正常示例

{
  "hash_type": "SHA1",
  "hash_value": "79bb0f45fc4c42234a918000b2668d689e2bde04",
  "download_url": "https://xxxx.xxx.xxx"
}

错误码公共错误码

状态码错误码描述解决方案
403NO_AUTH当前商户号没有使用该接口的权限请确认是否已经开通相关权限
400INVALID_REQUEST请求的账单日期已过期请检查 bill_date, 并重新调用
400NO_STATEMENT_EXIST请求的账单文件不存在请检查当前商户号请求的微信支付账户在指定日期是否有资金操作
400STATEMENT_CREATING请求的账单正在生成中请先检查当前商户号的微信支付账户在指定日期内是否有资金操作, 若有, 则在 T+1 日上午 10 点后再重新下载
500SYSTEM_ERROR系统错误系统异常, 请使用相同参数稍后重新调用
400PARAM_ERROR参数错误请使用正确的参数重新调用

最后修改 April 12, 2020: 整理文档 (f36b91e)