创建快捷交易协议号上传任务

更新时间:2024.11.18

创建快捷交易协议号上传任务,每个上传任务中需要上传一个快捷交易协议号文件。微信收到快捷交易协议号文件后,会识别出其中的微信用户,保存到指定的号码包中。一个号码包可以包含多个上传任务,这些上传任务导入的用户会被合并去重,再追加写到号码包。

接口说明

支持商户:【普通服务商】 【从业机构(银行)】 【从业机构(支付机构)】 【清算机构】 【渠道商】

请求方式:【POST】/v3/marketing/bank/packages/{package_id}/tasks

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


Content-Type  必填 string

请设置为multipart/form-data


path 路径参数

package_id  必填 string(16)

【号码包id】号码包唯一标识符。可在微信支付商户平台创建号码包后获得。


Form 表单

file  必填 object

将快捷交易协议号文件进行二进制转换,得到的二进制内容,在请求body中上传此二进制内容。只支持TXT或CSV格式的纯文本文件,每行一个加密后的协议号,换行符使用\n,编码格式使用utf-8。使用微信支付平台证书中的公钥逐个加密协议号,并将证书序列号包含在请求HTTP头部的Wechatpay-Serial。文件大小不能超过2MB,建议单个文件的行数不超过5500行。同一个号码包的多个上传任务的文件名不可重复。

属性

meta  必填 object

快捷协议号包的文件元信息

属性

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/marketing/bank/packages/8473295/tasks \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: multipart/form-data" \
6  -F file="{
7    "filename" : "example_filename",
8    "content_type" : "example_content_type",
9    "content" : "example_content"
10  }" \
11  -F meta="{
12    "filename" : "active_user.csv",
13    "sha256" : "addca90a6a290b9642dbaccffdf01e8c22aa348940b2e96754169ba08c19e5db",
14    "bank_type" : "ICBC_DEBIT"
15  }"

应答参数

200 OK

task_id  必填 string(16)

【上传任务】上传任务的主键,唯一定义此资源的标识


package_id  必填 string(16)

【号码包id】号码包唯一标识符。可在微信支付商户平台创建号码包后获得。


filename  必填 string(128)

【文件名】任务上传的文件名


create_time  必填 string(32)

【创建上传任务的时间】时间格式采用遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。


update_time  选填 string(32)

【上传任务最近一次更新的时间】时间格式采用遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。


status  选填 string

【任务状态】上传任务的状态:PROCESSING - 处理中,FINISHED - 已完成

可选取值:

  • PROCESSING: 上传任务处理中,请等待

  • FINISHED: 上传任务已处理完成,任务上传的文件中的用户已导入到号码包中


success_count  选填 integer

【成功数】匹配成功的协议号数。仅当任务状态是FINISHED时,该数据才有效


fail_count  选填 integer

【失败数】匹配失败的协议号数。仅当任务状态是FINISHED时,该数据才有效


success_user_count  选填 integer

【匹配成功的微信用户数】匹配成功的微信用户数,不小于匹配成功的协议号数。当一张银行卡被用户绑定到不同微信号时,才可能出现一个协议号对应多个微信账户的情况。仅当任务状态是FINISHED时,该数据才有效


bank_type  选填 string(32)

【银行类型】银行类型,用于标识协议号所属的银行以及卡类型(信用卡或借记卡)。采用字符串类型的银行标识,值列表详见银行类型

应答示例

200 OK

1{
2  "task_id" : "101",
3  "package_id" : "8473295",
4  "filename" : "active_user.csv",
5  "create_time" : "2020-05-20T13:29:35.120+08:00",
6  "update_time" : "2020-05-20T13:29:35.120+08:00",
7  "status" : "PROCESSING",
8  "success_count" : 1000,
9  "fail_count" : 20,
10  "success_user_count" : 1000,
11  "bank_type" : "ICBC_DEBIT"
12}
13

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

500

SYSTEM_ERROR

系统错误

系统异常,请使用相同参数稍后重新调用

 

 

反馈
咨询
目录
置顶