商戶平臺/API完成制券后,可使用發(fā)放代金券接口發(fā)券。通過調(diào)用此接口可發(fā)放指定批次給指定用戶,發(fā)券場景可以是小程序、H5、APP等。
注意:
- 商戶可在H5活動頁面、商戶小程序、商戶APP等自有場景內(nèi)調(diào)用該接口完成發(fā)券,商戶默認(rèn)只允許發(fā)放本商戶號(調(diào)用發(fā)券接口的商戶號)創(chuàng)建的代金券,如需發(fā)放其他商戶商戶創(chuàng)建的代金券,請參考常見問題 (opens new window)Q1。
- 跨商戶發(fā)券時,請求參數(shù)中除了stock_id和stock_creator_mchid為創(chuàng)建方提供的數(shù)據(jù),其他的所有調(diào)用數(shù)據(jù)都由發(fā)放方提供。
頻率限制:500/s
處理耗時:100ms
冪等規(guī)則:接口支持冪等重入
# 接口說明
支持商戶:
【普通商戶】
請求方式:
【POST】/v3/marketing/favor/users/{openid}/coupons
請求域名:
【主域名】
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ù)
- openid 必填 string(128)【用戶openid】 openid信息,用戶在appid下的唯一標(biāo)識。
校驗(yàn)規(guī)則:該openid需要與接口傳入中的appid有對應(yīng)關(guān)系。
Path 路徑參數(shù)
- stock_id 必填 string(20)【批次id】 微信為每個批次分配的唯一id。
校驗(yàn)規(guī)則:必須為代金券(全場券或單品券)批次號,不支持立減與折扣。 - out_request_no 必填 string(128)【商戶單據(jù)號】 商戶此次發(fā)放憑據(jù)號(格式:商戶id+日期+流水號),商戶側(cè)需保持唯一性
- appid 必填 string(128)【公眾賬號ID】 微信為發(fā)券方商戶分配的公眾賬號ID,接口傳入的所有appid應(yīng)該為公眾號的appid或者小程序的appid(在mp.weixin.qq.com申請的)或APP的appid(在open.weixin.qq.com申請的)。
校驗(yàn)規(guī)則:
1、該appid需要與接口傳入中的openid有對應(yīng)關(guān)系;
2、該appid需要與調(diào)用接口的商戶號(即請求頭中的商戶號)有綁定關(guān)系,若未綁定,可參考該指引完成綁定(商家商戶號與AppID賬號關(guān)聯(lián)管理) - stock_creator_mchid 必填 string(20)【創(chuàng)建批次的商戶號】 批次創(chuàng)建方商戶號。
校驗(yàn)規(guī)則:接口傳入的批次號需由stock_creator_mchid所創(chuàng)建。 - coupon_value 選填 integer【指定面額發(fā)券,面額】 指定面額發(fā)券場景,券面額,其他場景不需要填,單位:分。 (該字段暫未開放 )
校驗(yàn)規(guī)則:僅在發(fā)券時指定面額及門檻的場景才生效,常規(guī)發(fā)券場景請勿傳入該信息。 - coupon_minimum 選填 integer【指定面額發(fā)券,券門檻】 指定面額發(fā)券批次門檻,其他場景不需要,單位:分。 (該字段暫未開放 )
校驗(yàn)規(guī)則:僅在發(fā)券時指定面額及門檻的場景才生效,常規(guī)發(fā)券場景請勿傳入該信息。
Body 包體參數(shù)
請求示例
POST
# 應(yīng)答參數(shù)
- coupon_id 必填 string【代金券id】 微信為代金券唯一分配的id。
200OK
應(yīng)答示例
200 OK
# 錯誤碼
# 公共錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯誤 | 請根據(jù)錯誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗(yàn)證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | 商戶號與AppID不匹配 | 調(diào)用接口的商戶號需與接口傳入的AppID有綁定關(guān)系,請參考常見問題 (opens new window)Q4 |
400 | INVALID_REQUEST | OpenID與AppID不匹配 | OpenID與AppID需有對應(yīng)關(guān)系 |
400 | INVALID_REQUEST | 非法的商戶號 | 請檢查商戶號準(zhǔn)確性 |
400 | INVALID_REQUEST | 調(diào)用頻率過高 | 請降低API調(diào)用頻率 |
400 | INVALID_REQUEST | 活動已結(jié)束或未激活 | 請檢查批次狀態(tài) |
400 | INVALID_REQUEST | 批次信息獲取失敗,請確認(rèn)參數(shù)是否有誤 | 請檢查創(chuàng)建商戶號與批次號的對應(yīng)關(guān)系 |
400 | PARAM_ERROR | AppID必填 | 請輸入AppID |
400 | PARAM_ERROR | OpenID必填 | 請輸入OpenID |
400 | PARAM_ERROR | 批次號必填 | 請輸入批次號 |
400 | PARAM_ERROR | 商戶號必填 | 請輸入商戶號 |
400 | PARAM_ERROR | 非法的批次狀態(tài) | 請檢查批次狀態(tài),僅支持發(fā)放狀態(tài)為“運(yùn)營中”的代金券批次 |
403 | MCH_NOT_EXISTS | 商戶號不合法 | 請檢查商戶號準(zhǔn)確性 |
403 | NOT_ENOUGH | 批次預(yù)算不足 | 批次預(yù)算已發(fā)放完,請補(bǔ)充批次預(yù)算 |
403 | NOT_ENOUGH | 發(fā)券超過單天限額 | 已超過該批次設(shè)置的單天發(fā)放限制額度,無法發(fā)放 |
403 | NOT_ENOUGH | 賬戶余額不足,請充值 | 商戶號余額不足,無法繼續(xù)發(fā)券,請充值 |
403 | NOT_ENOUGH | 批次預(yù)算耗盡 | 該批次的預(yù)算已經(jīng)耗盡 |
403 | REQUEST_BLOCKED | 商戶無權(quán)發(fā)券 | 該批次不支持其他商戶發(fā)放,請參考常見問題 (opens new window)Q1 |
403 | REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次不支持其他商戶發(fā)放,請參考常見問題 (opens new window)Q1 |
403 | REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 該用戶已達(dá)到該批次的領(lǐng)取上限,請參考常見問題 (opens new window)Q6 |
403 | REQUEST_BLOCKED | 不能在API渠道發(fā)放 | 請檢查批次信息,僅支持發(fā)放微信支付代金券,不支持發(fā)放立減與折扣 |
403 | REQUEST_BLOCKED | 不支持指定面額發(fā)券 | 僅在發(fā)券時指定面額及門檻的場景才生效,常規(guī)發(fā)券場景請勿傳入該信息 |
403 | REQUEST_BLOCKED | 僅在廣告場景下發(fā)放批次 | 該批次已在朋友圈廣告發(fā)放,不支持在其他渠道發(fā)放 |
403 | RULE_LIMIT | 用戶已達(dá)最大領(lǐng)券次數(shù) | 該用戶已達(dá)到該批次的領(lǐng)取上限,請參考常見問題 (opens new window)Q6 |
403 | RULE_LIMIT | 被自然人規(guī)則攔截 | 該自然人已達(dá)到該批次的領(lǐng)取上限,請參考常見問題 (opens new window)Q6 |
403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 用戶命中微信支付風(fēng)控模型,請參考常見問題 (opens new window)Q5 |
404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請檢查批次及制券商戶號信息 |
429 | FREQUENCY_LIMITED | 當(dāng)前請求人數(shù)過多,請稍后重試 | 請降低API調(diào)用頻率 |