微信裂變紅包是指微信用戶在收到企業發送的組合紅包以後, 能夠再次將紅包中的剩餘金額分享給好友領取的一種現金紅包形式。php
春節期間,微信紅包以其獨特的魅力,優秀的用戶體驗和安全的支付環境,一經推出即受到了廣大用戶的熱烈歡迎,現微信支付現金紅包向微信支付商戶開發,具體能力以下: html
一、商戶調用接口時,經過指定發送對象以及發送金額的方式發放紅包,這樣的方式,容許商戶靈活的應用於各類各樣豐富的活動場景算法
二、領取到紅包後,用戶的資金直接進入微信零錢,避免繁複的領獎流程,帶給用戶微信支付原生的流暢體驗api
發送頻率規則安全
◆ 每分鐘發送紅包數量不得超過1800個;微信
◆ 北京時間0:00-8:00不觸發紅包贈送;(若是以上規則不知足您的需求,請發郵件至wxhongbao@tencent.com獲取升級指引)app
紅包規則微信公衆平臺
◆ 單個紅包金額介於[1.00元,1000.00元]之間;post
◆ 裂變組合中的每一個紅包平均金額介於[1.00元,200.00元]之間;微信支付
◆ 同一組裂變紅包只能發送給一個用戶;(若是以上規則不知足您的需求,請發郵件至wxhongbao@tencent.com獲取升級指引)
1.紅包發放說明
用於企業向微信用戶我的發裂變紅包
目前支持向指定微信用戶的openid發放指定金額裂變紅包。(獲取openid參見微信公衆平臺開發者文檔: 網頁受權獲取用戶基本信息)
◆ 商戶調用接口時,經過指定發送金額以及指定一位發送對象的方式發放一組紅包
◆ 指定發送對象領取到紅包後,資金直接進入微信零錢,帶給用戶微信支付原生的流暢體驗
◆ 指定發送對象可以將組合中的剩餘紅包分享給好友,好友可繼續領取,造成傳播效應,放大企業品牌價值
2.接口調用請求說明
請求Url |
https://api.mch.weixin.qq.com/mmpaymkttransfers/sendgroupredpack |
---|---|
是否須要證書 |
是(證書及使用說明詳見商戶證書) |
請求方式 |
POST |
3.請求參數
字段名 |
字段 |
必填 |
示例值 |
類型 |
說明 |
---|---|---|---|---|---|
隨機字符串 |
nonce_str |
是 |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
String(32) |
隨機字符串,不長於32位 |
簽名 |
sign |
是 |
C380BEC2BFD727A4B6845133519F3AD6 |
String(32) |
詳見簽名生成算法 |
商戶訂單號 |
mch_billno |
是 |
10000098201411111234567890 |
String(28) |
商戶訂單號(每一個訂單號必須惟一) 組成: mch_id+yyyymmdd+10位一天內不能重複的數字。 接口根據商戶訂單號支持重入, 如出現超時可再調用。 |
商戶號 |
mch_id |
是 |
10000098 |
String(32) |
微信支付分配的商戶號 |
子商戶號 |
sub_mch_id |
否 |
10000090 |
String(32) |
微信支付分配的子商戶號,受理模式下必填 |
公衆帳號appid |
wxappid |
是 |
wx8888888888888888 |
String(32) |
商戶appid |
商戶名稱 |
send_name |
是 |
天虹百貨 |
String(32) |
紅包發送者名稱 |
用戶openid |
re_openid |
是 |
oxTWIuGaIt6gTKsQRLau2M0yL16E |
String(32) |
接收紅包的種子用戶(首個用戶) 用戶在wxappid下的openid |
總金額 |
total_amount |
是 |
1000 |
int |
紅包發放總金額,即一組紅包金額總和,包括分享者的紅包和裂變的紅包,單位分 |
紅包發放總人數 |
total_num |
是 |
3 |
int |
紅包發放總人數,即總共有多少人能夠領到該組紅包(包括分享者) |
紅包金額設置 |
amt_type |
是 |
ALL_RAND |
String(32) |
紅包金額設置方式 ALL_RAND—所有隨機,商戶指定總金額和紅包發放總人數,由微信支付隨機計算出各紅包金額 ALL_SPECIFIED—所有自定義 SEED_SPECIFIED—種子紅包自定義,其餘隨機 |
各紅包金額 |
amt_list |
否 |
200|100|100 |
String(256) |
各紅包具體金額,自定義金額時必須設置,單位分 |
紅包祝福語 |
wishing |
是 |
感謝您參加猜燈謎活動,祝您元宵節快樂! |
String(128) |
紅包祝福語 |
活動名稱 |
act_name |
是 |
猜燈謎搶紅包活動 |
String(32) |
活動名稱 |
備註 |
remark |
是 |
猜越多得越多,快來搶! |
String(256) |
備註信息 |
商戶logo的url |
logo_imgurl |
否 |
https://wx.gtimg.com/mch/img/ico-logo.png |
String(128) |
商戶logo的url(暫未開放) |
背景水印圖片 |
watermark_imgurl |
否 |
https://wx.gtimg.com/mch/img/ico-logo.png |
String(128) |
背景水印圖片url |
詳情頁banner圖 |
banner_imgurl |
否 |
https://wx.gtimg.com/mch/img/ico-logo.png |
String(128) |
紅包詳情頁面的banner圖片url |
數據示例:
<xml> <sign><![CDATA[E1EE61A91C8E90F299DE6AE075D60A2D]]></sign> <mch_billno><![CDATA[0010010404201411170000046545]]></mch_billno> <mch_id><![CDATA[888]]></mch_id> <wxappid><![CDATA[wxcbda96de0b165486]]></wxappid> <send_name><![CDATA[send_name]]></send_name> <re_openid><![CDATA[onqOjjmM1tad-3ROpncN-yUfa6uI]]></re_openid> <total_amount><![CDATA[200]]></total_amount> <amt_type><![CDATA[ALL_RAND]]></amt_type> <amt_list><![CDATA[200|100|100]]></amt_list> <total_num><![CDATA[3]]></total_num> <wishing><![CDATA[恭喜發財]]></wishing> <act_name><![CDATA[新年紅包]]></act_name> <remark><![CDATA[新年紅包]]></remark> <logo_imgurl><![CDATA[https://xx/img/wxpaylogo.png]]></logo_imgurl> <share_content><![CDATA[share_content]]></share_content> <share_url><![CDATA[https://xx/img/wxpaylogo.png]]></share_url> <share_imgurl><![CDATA[https:/xx/img/wxpaylogo.png]]></share_imgurl> <watermark_imgurl><![CDATA[https:/xx/img/wxpaylogo.png]]></watermark_imgurl> <banner_imgurl><![CDATA[https:/xx/img/wxpaylogo.png]]></banner_imgurl> <nonce_str><![CDATA[50780e0cca98c8c8e814883e5caa672e]]></nonce_str> </xml> |
4.返回參數
字段名 |
變量名 |
必填 |
示例值 |
類型 |
說明 |
---|---|---|---|---|---|
返回狀態碼 |
return_code |
是 |
SUCCESS |
String(16) |
SUCCESS/FAIL 此字段是通訊標識,非交易標識,交易是否成功須要查看result_code來判斷 |
返回信息 |
return_msg |
否 |
簽名失敗
|
String(128) |
返回信息,如非空,爲錯誤緣由 簽名失敗 參數格式校驗錯誤 |
如下字段在return_code爲SUCCESS的時候有返回 |
|||||
簽名 |
sign |
是 |
C380BEC2BFD727A4B6845133519F3AD6 |
String(32) |
生成簽名方式詳見簽名生成算法 |
業務結果 |
result_code |
是 |
SUCCESS |
String(16) |
SUCCESS/FAIL |
錯誤代碼 |
err_code |
否 |
SYSTEMERROR |
String(32) |
錯誤碼信息 |
錯誤代碼描述 |
err_code_des |
否 |
系統錯誤 |
String(128) |
結果信息描述 |
如下字段在return_code 和result_code都爲SUCCESS的時候有返回 |
|||||
商戶訂單號 |
mch_billno |
是 |
10000098201411111234567890 |
String(28) |
商戶訂單號(每一個訂單號必須惟一) 組成: mch_id+yyyymmdd+10位一天內不能重複的數字 |
商戶號 |
mch_id |
是 |
10000098 |
String(32) |
微信支付分配的商戶號 |
公衆帳號appid |
wxappid |
是 |
wx8888888888888888 |
String(32) |
商戶appid |
用戶openid |
re_openid |
是 |
oxTWIuGaIt6gTKsQRLau2M0yL16E |
String(32) |
接收紅包的種子用戶(首個用戶) 用戶在wxappid下的openid |
總付款金額 |
total_amount |
是 |
1000 |
int |
總付款金額,單位分 |
發放成功時間 |
send_time |
是 |
20150227091010 |
String(14) |
紅包發放成功時間,格式爲yyyyMMddHHmmss,如2015年02月27日9點10分10秒錶示爲20150227091010 |
微信單號 |
send_listid |
是 |
1000000000201502270093647546 |
String(32) |
微信紅包訂單號 |
成功示例:
<xml> <return_code><![CDATA[SUCCESS]]></return_code> <return_msg><![CDATA[發放成功.]]></return_msg> <result_code><![CDATA[SUCCESS]]></result_code> <err_code><![CDATA[0]]></err_code> <err_code_des><![CDATA[發放成功.]]></err_code_des> <mch_billno><![CDATA[0010010404201411170000046545]]></mch_billno> <mch_id>10010404</mch_id> <wxappid><![CDATA[wx6fa7e3bab7e15415]]></wxappid> <re_openid><![CDATA[onqOjjmM1tad-3ROpncN-yUfa6uI]]></re_openid> <total_amount>3</total_amount> <send_time>20150227091010</send_time> <send_listid>1000000000201502270093647546</send_listid> </xml> |
失敗示例:
<xml> <return_code><![CDATA[FAIL]]></return_code> <return_msg><![CDATA[系統繁忙,請稍後再試.]]></return_msg> <result_code><![CDATA[FAIL]]></result_code> <err_code><![CDATA[268458547]]></err_code> <err_code_des><![CDATA[系統繁忙,請稍後再試.]]></err_code_des> <mch_billno><![CDATA[0010010404201411170000046542]]></mch_billno> <mch_id>10010404</mch_id> <wxappid><![CDATA[wx6fa7e3bab7e15415]]></wxappid> <re_openid><![CDATA[onqOjjmM1tad-3ROpncN-yUfa6uI]]></re_openid> <total_amount>3</total_amount> </xml> |
5.錯誤碼
錯誤碼 |
描述 |
解決方案 |
---|---|---|
CA_ERROR |
請求未攜帶證書,或請求攜帶的證書出錯 |
到商戶平臺下載證書,請求帶上證書後重試。 |
SIGN_ERROR |
商戶簽名錯誤 |
按文檔要求從新生成簽名後再重試。 |
FREQ_LIMIT |
受頻率限制 |
請對請求作頻率控制 |
XML_ERROR |
請求的xml格式錯誤,或者post的數據爲空 |
檢查請求串,確認無誤後重試 |
PARAM_ERROR |
參數錯誤 |
請查看err_code_des,修改設置錯誤的參數 |
OPENID_ERROR |
Openid錯誤 |
根據用戶在商家公衆帳號上的openid,獲取用戶在紅包公衆帳號上的openid 錯誤。請覈對商戶自身公衆號appid和用戶在此公衆號下的openid。 |
NOTENOUGH |
餘額不足 |
商戶帳號餘額不足,請登陸微信支付商戶平臺充值 |
FATAL_ERROR |
重複請求時,參數與原單不一致 |
使用相同商戶單號進行重複請求時,參數與第一次請求時不一致,請檢查並修改參數後再重試。 |
TIME_LIMITED |
企業紅包的發送時間受限 |
請北京時間0:00-8:00時間以外觸發紅包贈送 |
SECOND_OVER_LIMITED |
企業紅包的按分鐘發放受限 |
每分鐘發送紅包數量不得超過1800個;(可聯繫微信支付wxhongbao@tencent.com調高額度) |
DAY_ OVER_LIMITED |
企業紅包的按天日發放受限 |
單個商戶日發送紅包數量不大於10000個;(可聯繫微信支付wxhongbao@tencent.com調高額度) |
MONEY_LIMIT |
紅包金額發放限制 |
每一個紅包金額必須大於1元,小於1000元(可聯繫微信支付wxhongbao@tencent.com調高額度至4999元) |
XML_ERROR |
請求的xml格式錯誤,或者post的數據爲空 |
檢查請求串,確認無誤後重試 |
SEND_FAILED |
紅包發放失敗,請更換單號再重試 |
原商戶單號已經失敗,若是還要對同一個用戶發放紅包, 須要更換新的商戶單號再試。 |
SYSTEMERROR |
系統繁忙,請再試。 |
可用同一商戶單號再次調用,只會發放一個紅包 |