最新更新时间:2022.04.19 版本说明
服务商可以调用此接口获取购付汇账单文件下载链接。在有效期内请求下载链接可以下载出账日为指定日期的购付汇账单文件。
• 账单文件的下载地址的有效时间为30s;
• 强烈建议商户将实际账单文件的哈希值和之前从接口获取到的哈希值进行比对,以确认数据的完整性。
有关账单的说明:
购付汇账单中提供的是前一天购付汇完成、最终出境成功的账单,还未完成出境或出境失败的出境单不会出现在账单中。
注:在出境请求被受理之后,预计购汇时间为T+1(其中T为受理日期)。
通过下载链接获取到的账单文件为资金出境购付汇账单,出账日期为T+1,即当天下载的是前一天购付汇完成的出境成功账单。
一般在凌晨6点后可以下载到前一天的账单,实际账单下载的情况请关注错误码提示。
提示,下载三个月前或更早的历史数据时下载速度可能会变慢。
账单中涉及金额的字段单位为“元”。
当获取到账单文件资源的下载地址信息后, 可以通过微信支付API v3标准对download_url进行签名,并发起请求,即可下载到账单文件的数据流。
适用对象:电商平台
请求URL:https://api.mch.weixin.qq.com/v3/funds-to-oversea/bill-download-url
请求方式:GET
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
账单日期 | bill_date | string[10, 10] | 是 | query格式yyyy-MM-DD 示例值:2021-01-01 |
子商户号 | sub_mchid | string[1, 20] | 否 | query
1. 不填则默认返回服务商下的账单数据 2. 如需下载某个子商户下的账单数据,则该字段必填 示例值:19000000001 |
https://api.mch.weixin.qq.com/v3/funds-to-oversea/bill-download-url?bill_date=2021-01-01&sub_mchid=19000000001
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
哈希类型 | hash_type | string | 是 |
SHA1:SHA1值,Secure Hash Algorithm 1 示例值:SHA1 |
哈希值 | hash_value | string[1,1024] | 是 | 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。 建议将实际账单文件的哈希值和该哈希值进行比对,以确认数据的完整性。 示例值:79bb0f45fc4c42234a918000b2668d689e2bde04 |
下载地址 | download_url | string[1,2048] | 是 | 下载地址5min内有效 示例值:https://api.mch.weixin.qq.com/v3/bill/downloadurl?token=xxx |
{
"download_url": "https://api.mch.weixin.qq.com/v3/bill/downloadurl?token=xxx",
"hash_type": "SHA1",
"hash_value": "79bb0f45fc4c42234a918000b2668d689e2bde04"
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
403 | NO_AUTH | 商户无权限申请资金出境 | 商户无权限申请资金出境,请申请相关权限 |
400 | PARAM_ERROR | 参数错误 | 请求参数错误,请重新检查再调用查询剩余可出境余额 |