商戶可以通過調(diào)用此接口創(chuàng)建微信支付代金券批次,包括預(yù)充值&免充值代金券;創(chuàng)建完成后將獲得代金券批次id,將可用于各個(gè)營銷場景的活動(dòng)投放。
接口頻率:單個(gè)商戶號(hào)調(diào)用頻率60/min,所有商戶號(hào)調(diào)用頻率為1000/min
接口耗時(shí):500ms
# 接口說明
支持商戶:
【普通服務(wù)商】【從業(yè)機(jī)構(gòu)(銀行)】【從業(yè)機(jī)構(gòu)(支付機(jī)構(gòu))】【渠道商】【清算機(jī)構(gòu)】
請求方式:
【POST】/v3/marketing/favor/coupon-stocks
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點(diǎn) ,指引點(diǎn)擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請?jiān)O(shè)置為
application/json
- Content-Type 必填 string請?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- stock_name 必填 string(20)【批次名稱】 批次名稱
校驗(yàn)規(guī)則:
1、批次名稱最多9個(gè)中文漢字
2、批次名稱最多20個(gè)字母
3、批次名稱中不能包含不當(dāng)內(nèi)容和特殊字符 _ , ; | - comment 選填 string(60)【批次備注】 僅配置商戶可見,用于自定義信息
- belong_merchant 必填 string(20)【歸屬商戶號(hào)】 批次歸屬商戶號(hào)
本字段暫未開放生效,但入?yún)r(shí)請?jiān)O(shè)置為當(dāng)前創(chuàng)建代金券商戶號(hào)即不會(huì)報(bào)錯(cuò),暫時(shí)不支持入?yún)⑵渌纳虘籼?hào) - available_begin_time 必填 string【可用時(shí)間-開始時(shí)間】 批次開始時(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秒。
校驗(yàn)規(guī)則:
1、開始時(shí)間不可早于當(dāng)前時(shí)間
2、不能創(chuàng)建365天后開始的批次
3、批次可用時(shí)間范圍最長為90天 - available_end_time 必填 string【可用時(shí)間-結(jié)束時(shí)間】 批次結(jié)束時(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秒。 - stock_use_rule 必填 StockRule【發(fā)放規(guī)則】 批次使用規(guī)則
- 屬性
- pattern_info 選填 PatternInfo【代金券詳情頁】 代金券詳情頁
- 屬性
- coupon_use_rule 必填 CouponRule【核銷規(guī)則】
- 屬性
- no_cash 必填 boolean【營銷經(jīng)費(fèi)】 營銷經(jīng)費(fèi)。
枚舉值:
true:免充值
false:預(yù)充值
1、免充值:制券方無需提前充值資金,用戶核銷代金券時(shí),直接從訂單原價(jià)中扣除優(yōu)惠減價(jià)金額,最終只將用戶實(shí)際支付的金額結(jié)算給核銷商戶,商戶實(shí)收少于訂單原價(jià)。
2、預(yù)充值:制券方需將優(yōu)惠預(yù)算提前充值到微信支付商戶可用余額中,用戶核銷代金券時(shí),系統(tǒng)從制券方商戶可用余額中扣除優(yōu)惠減價(jià)部分對應(yīng)的資金,連同用戶實(shí)際支付的資金,一并結(jié)算給核銷商戶,不影響實(shí)收。 - stock_type 必填 string(16)【批次類型】 批次類型,僅支持:
NORMAL:固定面額滿減券批次 - out_request_no 必填 string(128)【商戶單據(jù)號(hào)】 商戶創(chuàng)建批次憑據(jù)號(hào)(格式:商戶id+日期+流水號(hào)),可包含英文字母,數(shù)字,|,_,*,-等內(nèi)容,不允許出現(xiàn)其他不合法符號(hào),商戶側(cè)需保持商戶單據(jù)號(hào)全局唯一。
- ext_info 選填 string(128)【擴(kuò)展屬性】 擴(kuò)展屬性字段,按json格式,如無需要?jiǎng)t不填寫。
該字段暫未開放
Body 包體參數(shù)
請求示例
POST
# 應(yīng)答參數(shù)
- stock_id 必填 string【批次號(hào)】 微信為每個(gè)代金券批次分配的唯一ID。
- create_time 必填 string【創(chuàng)建時(shí)間】 創(chuàng)建時(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秒。
200OK
應(yīng)答示例
200 OK
# 錯(cuò)誤碼
# 公共錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請根據(jù)錯(cuò)誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗(yàn)證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | 商戶號(hào)與AppID不匹配 | 請綁定調(diào)用接口的商戶號(hào)和AppID后重試 |
400 | INVALID_REQUEST | OpenID與AppID不匹配 | 請使用AppID下的OpenID |
400 | INVALID_REQUEST | 活動(dòng)已結(jié)束或未激活 | 請檢查批次狀態(tài) |
400 | INVALID_REQUEST | 非法的商戶號(hào) | 請檢查商戶號(hào)是否正確 |
400 | MCH_NOT_EXISTS | 商戶號(hào)不合法 | 請輸入正確的商戶號(hào) |
400 | PARAM_ERROR | 回調(diào)URL不能為空 | 請?zhí)顚懟卣{(diào)URL |
400 | PARAM_ERROR | 回調(diào)商戶不能為空 | 請?zhí)顚懟卣{(diào)商戶 |
400 | PARAM_ERROR | 券ID必填 | 請?zhí)顚懭疘D |
400 | PARAM_ERROR | AppID必填 | 請輸入AppID |
400 | PARAM_ERROR | OpenID必填 | 請輸入OpenID |
400 | PARAM_ERROR | 頁大小超過閾值 | 請不要超過最大的頁大小 |
400 | PARAM_ERROR | 輸入時(shí)間格式錯(cuò)誤 | 請輸入正確的時(shí)間格式 |
400 | PARAM_ERROR | 批次號(hào)必填 | 請輸入批次號(hào) |
400 | PARAM_ERROR | 商戶號(hào)必填 | 請輸入商戶號(hào) |
400 | PARAM_ERROR | 非法的批次狀態(tài) | 請檢查批次狀態(tài) |
403 | NO_AUTH | 你配置的信息需要開通特殊權(quán)限 | 請參考:QA方案 (opens new window) |
403 | NOT_ENOUGH | 批次預(yù)算不足 | 請補(bǔ)充預(yù)算 |
403 | REQUEST_BLOCKED | 調(diào)用商戶無權(quán)限 | 請開通產(chǎn)品權(quán)限后再調(diào)用該接口 |
403 | REQUEST_BLOCKED | 商戶無權(quán)發(fā)券 | 調(diào)用接口的商戶號(hào)無權(quán)發(fā)券,請檢查是否是自己的批次或是已授權(quán)的批次。 |
403 | REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號(hào)的授權(quán),請授權(quán)后再發(fā)放 |
403 | REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 用戶領(lǐng)取已經(jīng)達(dá)到上限,請調(diào)高上限或停止發(fā)放。 |
403 | REQUEST_BLOCKED | 活動(dòng)未開始或已結(jié)束 | 該活動(dòng)未開始或已結(jié)束 |
403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號(hào)異常,無法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請檢查批次ID是否正確 |
429 | FREQUENCY_LIMITED | 請求過于頻繁 | 稍后重試 |