最新更新時(shí)間:2021.09.23 版本說明
創(chuàng)建快捷交易協(xié)議號(hào)上傳任務(wù),每個(gè)上傳任務(wù)中需要上傳一個(gè)快捷交易協(xié)議號(hào)文件。微信收到快捷交易協(xié)議號(hào)文件后,會(huì)識(shí)別出其中的微信用戶,保存到指定的號(hào)碼包中。一個(gè)號(hào)碼包可以包含多個(gè)上傳任務(wù),這些上傳任務(wù)導(dǎo)入的用戶會(huì)被合并去重,再追加寫到號(hào)碼包。
適用對(duì)象:服務(wù)商
請(qǐng)求URL:https://api.mch.weixin.qq.com/v3/marketing/bank/packages/{package_id}/tasks
請(qǐng)求主體類型:multipart/form-data
請(qǐng)求方式:POST
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請(qǐng)求URL傳參
body 指該參數(shù)需在請(qǐng)求JSON傳參
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
號(hào)碼包id | package_id | string[4, 16] | 是 | path號(hào)碼包唯一標(biāo)識(shí)符。可在微信支付商戶平臺(tái)創(chuàng)建號(hào)碼包后獲得。 示例值:8473295 |
+快捷交易協(xié)議號(hào)文件 | file | object | 是 | body將快捷交易協(xié)議號(hào)文件進(jìn)行二進(jìn)制轉(zhuǎn)換,得到的二進(jìn)制內(nèi)容,在請(qǐng)求body中上傳此二進(jìn)制內(nèi)容。只支持TXT或CSV格式的純文本文件,每行一個(gè)加密后的協(xié)議號(hào),換行符使用\n,編碼格式使用utf-8。使用微信支付平臺(tái)證書中的公鑰逐個(gè)加密協(xié)議號(hào)。文件大小不能超過2MB,建議單個(gè)文件的行數(shù)不超過5500行。同一個(gè)號(hào)碼包的多個(gè)上傳任務(wù)的文件名不可重復(fù)。 |
+文件元信息 | meta | object | 是 | body快捷協(xié)議號(hào)包的文件元信息 |
---示例代碼待更新---
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
銀行類型 | bank_type | string[1, 32] | 否 | 銀行類型,用于標(biāo)識(shí)協(xié)議號(hào)所屬的銀行以及卡類型(信用卡或借記卡)。采用字符串類型的銀行標(biāo)識(shí),值列表詳見銀行類型 示例值:ICBC_DEBIT |
創(chuàng)建上傳任務(wù)的時(shí)間 | create_time | string[8, 32] | 是 | 時(shí)間格式采用遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35.+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 示例值:2020-05-20T13:29:35+08:00 |
失敗數(shù) | fail_count | int | 否 | 匹配失敗的協(xié)議號(hào)數(shù)。僅當(dāng)任務(wù)狀態(tài)是FINISHED時(shí),該數(shù)據(jù)才有效 示例值:20 |
文件名 | filename | string[4, 128] | 是 | 任務(wù)上傳的文件名 示例值:active_user.csv |
號(hào)碼包id | package_id | string[4, 16] | 是 | 號(hào)碼包唯一標(biāo)識(shí)符。可在微信支付商戶平臺(tái)創(chuàng)建號(hào)碼包后獲得。 示例值:8473295 |
任務(wù)狀態(tài) | status | string[1, 16] | 否 | 上傳任務(wù)的狀態(tài) PROCESSING:處理中,上傳任務(wù)處理中,請(qǐng)等待 FINISHED:已完成,上傳任務(wù)已處理完成,任務(wù)上傳的文件中的用戶已導(dǎo)入到號(hào)碼包中 示例值:PROCESSING |
成功數(shù) | success_count | int | 否 | 匹配成功的協(xié)議號(hào)數(shù)。僅當(dāng)任務(wù)狀態(tài)是FINISHED時(shí),該數(shù)據(jù)才有效 示例值:1000 |
匹配成功的微信用戶數(shù) | success_user_count | int | 否 | 匹配成功的微信用戶數(shù),不小于匹配成功的協(xié)議號(hào)數(shù)。當(dāng)一張銀行卡被用戶綁定到不同微信號(hào)時(shí),才可能出現(xiàn)一個(gè)協(xié)議號(hào)對(duì)應(yīng)多個(gè)微信賬戶的情況。僅當(dāng)任務(wù)狀態(tài)是FINISHED時(shí),該數(shù)據(jù)才有效 示例值:1000 |
上傳任務(wù) | task_id | string[1, 16] | 是 | 上傳任務(wù)的主鍵,唯一定義此資源的標(biāo)識(shí) 示例值:101 |
上傳任務(wù)最近一次更新的時(shí)間 | update_time | string[8, 32] | 否 | 時(shí)間格式采用遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35.+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 示例值:2020-05-20T13:29:35+08:00 |
{
"bank_type": "ICBC_DEBIT",
"create_time": "2020-05-20T13:29:35+08:00",
"fail_count": 20,
"filename": "active_user.csv",
"package_id": "8473295",
"status": "PROCESSING",
"success_count": 1000,
"success_user_count": 1000,
"task_id": "101",
"update_time": "2020-05-20T13:29:35+08:00"
}
快捷交易協(xié)議號(hào)文件內(nèi)容需要遵循特定格式,才能夠正確解析和識(shí)別為微信用戶。
格式說明:
1、為保證數(shù)據(jù)安全,快捷交易協(xié)議號(hào)需要加密后上傳。加密方法可參考敏感信息加解密,使用微信支付平臺(tái)證書中的公鑰,逐個(gè)加密快捷交易協(xié)議號(hào)。
2、文件內(nèi)容:每行一個(gè)加密后的快捷交易協(xié)議號(hào),換行符使用\n,不能使用\r\n,不允許包含空行。
3、文件大小不能超過2MB,建議單個(gè)文件的行數(shù)不超過5500行。
1.創(chuàng)建一個(gè)POST的方法請(qǐng)求/upload URI
例如: POST https://api.mch.weixin.qq.com/v3/marketing/bank/packages/{package_id}/tasks HTTP/1.1
2.將文件的數(shù)據(jù)添加到請(qǐng)求主體
2.1 文本文件file參數(shù)的獲取方式說明:
文本文件二進(jìn)制內(nèi)容,放在請(qǐng)求http的body中。
2.2 文本文件元信息meta參數(shù)的獲取方式說明:
文本文件元信息,使用json表示,包含三個(gè)對(duì)象:bank_type、filename、sha256。
● bank_type參數(shù)獲取方式說明:
銀行類型,用于標(biāo)識(shí)協(xié)議號(hào)所屬的銀行以及卡類型(信用卡或借記卡)。采用字符串類型的銀行標(biāo)識(shí),值列表詳見銀行類型
● filename參數(shù)獲取方式說明:
快捷協(xié)議號(hào)包文件名。可包含英文字母,數(shù)字,_,.,-等內(nèi)容,不允許出現(xiàn)其他不合法符號(hào)。同一個(gè)號(hào)碼包的多個(gè)上傳任務(wù)的文件名不可重復(fù),要保證唯一
● sha256參數(shù)獲取方式說明:
快捷交易協(xié)議號(hào)文件的文件摘要,即快捷交易協(xié)議號(hào)文件的二進(jìn)制內(nèi)容進(jìn)行sha256計(jì)算得到的值
2.3 簽名計(jì)算說明:
簽名生成
參與簽名計(jì)算的請(qǐng)求主體為meta的json串:
{ "bank_type": "ICBC_DEBIT","filename": "active_user.csv", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk" }
待簽名串示例:
POST
/v3/marketing/bank/packages/{package_id}/tasks
1566987169 //時(shí)間戳
12ced2db6f0193dda91ba86224ea1cd8 //隨機(jī)數(shù)
{ "bank_type": "ICBC_DEBIT","filename": "active_user.csv", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk" }
3.添加HTTP頭:
Content-Type:multipart/form-data.設(shè)置為要上載的對(duì)象的MIME媒體類型。
Authorization: WECHATPAY2-SHA256-RSA2048 mchid="1900231671",
nonce_str="PCHK6HSOEDTACETP6P3AL7DWPHTBKIAT",timestamp="1567067659",
serial_no="1FB89742D19F2BD30B69948D16DECA0FCB4481EB",
signature="PB6M7+3JL7TSCl5zqD1sdWVypOIEQsD4dgOU+vPiVM6GMRo2qYSWKf8u46i9ZJFhyZTBdZ7SFR+BjDZh6
89hFgN8LZL+QWTvq3cse/FEUFYyOLN7L/2IZX4GA4cWInuJ2MpOhZRMpm+emrcn42gTMKAPNQ7dBLO7ux6MoSuQp69
PW+p1ogmkER68exTVUXYqA5P3vITlWNr++RDy2+ExvB7qVISOKW0vBkxUxN9e7hwUbDwGln170ZXomoO1KpQSbw3f1u
WUCx/IlWJhJIun7rUMtVT+kfijNUqcILtSfE4hWKKVaZn9j5CX8M7aKbbDOFy3SvbSJ3WQgRnRbgog5w=="
Content-Type: multipart/form-data;boundary=boundary
4.添加body:
// 以下為body的內(nèi)容
--boundary // boundary為商戶自定義的一個(gè)字符串
Content-Disposition: form-data; name="meta";
Content-Type: application/json
//此處必須有一個(gè)空行
{ "bank_type": "ICBC_DEBIT","filename": "active_user.csv", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk" }
--boundary
Content-Disposition: form-data; name="file"; filename="active_user.csv";
Content-Type: text/plain
//此處必須有一個(gè)空行
cvs //cvs即為快捷交易協(xié)議號(hào)文件的二進(jìn)制內(nèi)容
--boundary--
說明:請(qǐng)求包體每行結(jié)尾都需要包含\r\n(空行也需要)。
5.發(fā)送請(qǐng)求
POST /v3/marketing/bank/packages/{package_id}/tasks HTTP/1.1
Host: api.mch.weixin.qq.com
Authorization: WECHATPAY2-SHA256-RSA2048
mchid="1900231671",nonce_str="PCHK6HSOEDTACETP6P3AL7DWPHTBKIAT",
timestamp="1567067659",
serial_no="1FB89742D19F2BD30B69948D16DECA0FCB4481EB",
signature="PB6M7+3JL7TSCl5zqD1sdWVypOIEQsD4dgOU+vPiVM6GMRo2qYSWKf8u46i9ZJFhyZTBdZ7
SFR+BjDZh689hFgN8LZL+QWTvq3cse/FEUFYyOLN7L/2IZX4GA4cWInuJ2MpOhZRMpm+emrcn42gTMKAPN
Q7dBLO7ux6MoSuQp69PW+p1ogmkER68exTVUXYqA5P3vITlWNr++RDy2+ExvB7qVISOKW0vBkxUxN9e
7hwUbDwGln170ZXomoO1KpQSbw3f1uWUCx/IlWJhJIun7rUMtVT+kfijNUqcILtSfE4hWKKVaZn9j5CX8M
7aKbbDOFy3SvbSJ3WQgRnRbgog5w=="
Content-Type: multipart/form-data;boundary=boundary
--boundary
Content-Disposition: form-data; name="meta";
Content-Type: application/json
{ "bank_type": "ICBC_DEBIT","filename": "active_user.csv", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk" }
--boundary
Content-Disposition: form-data; name="file"; filename="active_user.csv";
Content-Type: text/plain
cvs
--boundary--
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | HTTP header缺少微信支付平臺(tái)證書序列號(hào)(Wechatpay-Serial) | 將加密快捷交易協(xié)議號(hào)時(shí)所使用的平臺(tái)證書的序列號(hào),設(shè)置到HTTP頭部的Wechatpay-Serial |
400 | INVALID_REQUEST | 號(hào)碼包id未填或格式不正確 | url中的號(hào)碼包id錯(cuò)誤,請(qǐng)檢查 |
文件內(nèi)容為空 | 請(qǐng)?jiān)谖募刑畛浼用芎蟮目旖萁灰讌f(xié)議號(hào),每行一個(gè),使用\n作換行符,然后再上傳 | ||
文件大小超出限制,請(qǐng)分成多個(gè)文件上傳 | 文件大小不能超過限制,可分割成若干小文件再上傳 | ||
meta和file中的文件名不一致 | 請(qǐng)參考示例設(shè)置請(qǐng)求參數(shù) | ||
基于文件內(nèi)容計(jì)算的sha256與meta傳入的sha256不相等 | 請(qǐng)商戶確認(rèn)文件摘要是否正確計(jì)算 | ||
文件的換行符不支持\r\n,請(qǐng)使用\n | 請(qǐng)使用\n換行符 | ||
文件不允許存在空行 | 先刪掉空行,再重新上傳 | ||
不支持的銀行類型,請(qǐng)檢查并重試 | 參考確認(rèn)銀行類型的正確性 | ||
同一號(hào)碼包不可重復(fù)上傳同名文件 | 先確認(rèn)文件內(nèi)容是否重復(fù),如果是新內(nèi)容,請(qǐng)重新命名后上傳 | ||
404 | NOT_FOUND | 未找到指定號(hào)碼包 | 請(qǐng)商戶確認(rèn)號(hào)碼包是否由自己創(chuàng)建,只能由創(chuàng)建方導(dǎo)入定向用戶協(xié)議號(hào) |
500 | SYSTEM_ERROR | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)異常,請(qǐng)使用相同參數(shù)稍后重新調(diào)用 |