最新更新时间:2021.10.26 版本说明
转账电子回单申请受理接口,商户通过该接口可以申请受理电子回单服务。
• 发起转账时传入了收款用户姓名,支持申请电子回单;
• 支持受理最近30天内的转账明批次单;
• 仅支持已完成状态且至少一笔成功记录的批次获取电子回单(不满足条件返回:400 INVALID_REQUEST);
适用对象:直连商户
请求URL:https://api.mch.weixin.qq.com/v3/transfer/bill-receipt
请求方式:POST
接口限频: 单个商户 20QPS,如果超过频率限制,会报错FREQUENCY_LIMITED,请降低频率请求。
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商家批次单号 | out_batch_no | string[5, 32] | 是 | body商户系统内部的商家批次单号,在商户系统内部唯一。需要电子回单的批次单号 示例值:plfk2020042013 |
{
"out_batch_no": "plfk2020042013"
}
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商家批次单号 | out_batch_no | string[5,32] | 是 | 商户系统内部的商家批次单号,在商户系统内部唯一。需要电子回单的批次单号 示例值:plfk2020042013 |
电子回单申请单号 | signature_no | string[3,45] | 是 | 电子回单申请单号,申请单据的唯一标识 示例值:1050000010509999485212020110200058820001 |
电子回单状态 | signature_status | string[1,10] | 否 | 枚举值: ACCEPTED:已受理,电子签章已受理成功 FINISHED:已完成。电子签章已处理完成 示例值:ACCEPTED |
电子回单文件的hash方法 | hash_type | string[1,20] | 否 | 电子回单文件的hash方法,回单状态为:FINISHED时返回。 示例值:SHA256 |
电子回单文件的hash值 | hash_value | string[3,1000] | 否 | 电子回单文件的hash值,用于下载之后验证文件的完整、正确性,回单状态为:FINISHED时返回。 示例值:DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529 |
电子回单文件的下载地址 | download_url | string[10,3000] | 否 | 电子回单文件的下载地址,回单状态为:FINISHED时返回。URL有效时长为10分钟,10分钟后需要重新去获取下载地址(但不需要走受理) 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx |
创建时间 | create_time | string[1, 32] | 否 | 电子签章单创建时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒 示例值:2020-05-20T13:29:35.120+08:00 |
更新时间 | update_time | string[1, 32] | 否 | 电子签章单最近一次状态变更的时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒 示例值:2020-05-21T13:29:35.120+08:00 |
{
"out_batch_no": "plfk2020042013",
"signature_no": "1050000010509999485212020110200058820001",
"signature_status": "ACCEPTED",
"hash_type": "SHA256",
"hash_value": "DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529",
"download_url": "https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx",
"create_time": "2020-05-20T13:29:35.120+08:00",
"update_time": "2020-05-21T13:29:35.120+08:00"
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系统错误 | 重试 |
403 | NO_AUTH | 商户信息不合法 | 登录商户平台核对,传入正确信息 |
400 | INVALID_REQUEST | 参数错误或者不符合业务规则 | 传入正确参数 |
PARAM_ERROR | 参数错误 | 登录商户平台核对,输入正确参数 | |
RESOURCE_ALREADY_EXISTS | 该批次回单已申请 | 该商家的电子回单已受理 | |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低频率重试 |