获取购付汇账单文件下载链接

更新时间:2023.05.25

服务商可以调用此接口获取购付汇账单文件下载链接。在有效期内请求下载链接可以下载出账日为指定日期的购付汇账单文件。

有关账单的说明:

  • 购付汇账单中提供的是前一天购付汇完成、最终出境成功的账单,还未完成出境或出境失败的出境单不会出现在账单中。注:在出境请求被受理之后,预计购汇时间为T+1(其中T为受理日期)。
  • 通过下载链接获取到的账单文件为资金出境购付汇账单,出账日期为T+1,即当天下载的是前一天购付汇完成的出境成功账单。
  • 一般在凌晨6点后可以下载到前一天的账单,实际账单下载的情况请关注错误码提示。
  • 提示,下载三个月前或更早的历史数据时下载速度可能会变慢。
  • 账单中涉及金额的字段单位为“元”。

当获取到账单文件资源的下载地址信息后,如:

1{
2 "hash_type": "SHA1",
3 "hash_value": "79bb0f45fc4c42234a918000b2668d689e2bde04",
4 "download_url": " https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx"
5}

可以通过微信支付API v3标准对download_url进行签名,并发起请求,即可下载到账单文件的数据流。

注意

  • 账单文件的下载地址的有效时间为30s;
  • 强烈建议商户将实际账单文件的哈希值和之前从接口获取到的哈希值进行比对,以确认数据的完整性。

# 接口说明

支持商户:
【普通服务商】
请求方式:
【GET】/v3/funds-to-oversea/bill-download-url
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Query 查询参数
  • bill_date 必填 string(10)
    【账单日期】 格式YYYY-MM-DD
  • sub_mchid 选填 string(20)
    【子商户号】 若商户是直连商户:
    - 无需填写该字段
    若商户是服务商:
    - 不填则默认返回服务商下的账单数据
    - 如需下载某个子商户下的账单数据,则该字段必填

请求示例

GET

# 应答参数

    200OK
  • hash_type 必填 string
    【哈希类型】 哈希类型
    可选取值:
    • SHA1: Secure Hash Algorithm 1
  • hash_value 必填 string(1024)
    【哈希值】 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。
    建议将实际账单文件的哈希值和该哈希值进行比对,以确认数据的完整性。
  • download_url 必填 string(2048)
    【下载地址】 下载地址5min内有效

应答示例

200 OK

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

状态码 错误码 描述 解决方案
403 NO_AUTH 商户无权限申请资金出境 商户无权限申请资金出境,请申请相关权限
反馈
咨询
目录