最新更新時間:2019.09.27 版本說明
商戶平臺/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)建的代金券,請參考常見問題Q1。
適用對象:直連商戶 服務(wù)商 渠道商
請求URL:https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons
請求方式:POST
頻率限制:500/s
處理耗時:100ms
接口規(guī)則:http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
冪等規(guī)則:接口支持冪等重入
path指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請求URL傳參
body 指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
批次號 | stock_id | string[1,20] | 是 | body 微信為每個批次分配的唯一id。 校驗規(guī)則:必須為代金券(全場券或單品券)批次號,不支持立減與折扣。 示例值:9856000 |
用戶openid | openid | string[1,128] | 是 | path openid信息,用戶在appid下的唯一標(biāo)識。 校驗規(guī)則:該openid需要與接口傳入中的appid有對應(yīng)關(guān)系。 示例值:2323dfsdf342342 |
商戶單據(jù)號 | out_request_no | string[1,128] | 是 | body 商戶此次發(fā)放憑據(jù)號(格式:商戶id+日期+流水號),可包含英文字母,數(shù)字,|,_,*,-等內(nèi)容,不允許出現(xiàn)其他不合法符號,商戶側(cè)需保持唯一性。 示例值: 89560002019101000121 |
公眾賬號ID | appid | string[1,128] | 是 | body 微信為發(fā)券方商戶分配的公眾賬號ID,接口傳入的所有appid應(yīng)該為公眾號的appid或者小程序的appid(在mp.weixin.qq.com申請的),不能為APP的appid(在open.weixin.qq.com申請的)。。 校驗規(guī)則: 1、該appid需要與接口傳入中的openid有對應(yīng)關(guān)系; 2、該appid需要與調(diào)用接口的商戶號(即請求頭中的商戶號)有綁定關(guān)系,若未綁定,可參考該指引完成綁定(商家商戶號與AppID賬號關(guān)聯(lián)管理) 示例值:wx233544546545989 |
創(chuàng)建批次的商戶號 | stock_creator_mchid | string[1,20] | 是 | body 批次創(chuàng)建方商戶號。 校驗規(guī)則:接口傳入的批次號需由stock_creator_mchid所創(chuàng)建。 示例值:8956000 |
指定面額發(fā)券,面額 | coupon_value | uint64 | 否 | body 指定面額發(fā)券場景,券面額,其他場景不需要填,單位:分。 校驗規(guī)則:僅在發(fā)券時指定面額及門檻的場景才生效,常規(guī)發(fā)券場景請勿傳入該信息。 示例值:100 |
指定面額發(fā)券,券門檻 | coupon_minimum | uint64 | 否 | body 指定面額發(fā)券批次門檻,其他場景不需要,單位:分。 校驗規(guī)則:僅在發(fā)券時指定面額及門檻的場景才生效,常規(guī)發(fā)券場景請勿傳入該信息。 示例值:100 |
{
"stock_id": "9856000",
"out_request_no": "89560002019101000121",
"appid": "wx233544546545989",
"stock_creator_mchid": "8956000"
}
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
代金券id | coupon_id | string[1,20] | 是 | 微信為代金券唯一分配的id。 示例值:9867041 |
{
"coupon_id": "9867041"
}
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | appid必填 | 請輸入appid |
PARAM_ERROR | openid必填 | 請輸入openid | |
PARAM_ERROR | 批次號必填 | 請輸入批次號 | |
PARAM_ERROR | 商戶號必填 | 請輸入商戶號 | |
PARAM_ERROR | 非法的批次狀態(tài) | 請檢查批次狀態(tài),僅支持發(fā)放狀態(tài)為“運(yùn)營中”的代金券批次 | |
APPID_MCHID_NOT_MATCH | 商戶號與appid不匹配 | 調(diào)用接口的商戶號需與接口傳入的APPID有綁定關(guān)系,請參考常見問題Q4 | |
INVALID_REQUEST | openid與appID不匹配 | openid與appid需有對應(yīng)關(guān)系 | |
INVALID_REQUEST | 非法的商戶號 | 請檢查商戶號準(zhǔn)確性 | |
INVALID_REQUEST | 調(diào)用頻率過高 | 請降低api調(diào)用頻率 | |
INVALID_REQUEST | 活動已結(jié)束或未激活 | 請檢查批次狀態(tài) | |
403 | MCH_NOT_EXISTS | 商戶號不合法 | 請檢查商戶號準(zhǔn)確性 |
NOT_ENOUGH | 批次預(yù)算不足 | 批次預(yù)算已發(fā)放完,請補(bǔ)充批次預(yù)算 | |
NOT_ENOUGH | 發(fā)券超過單天限額 | 已超過該批次設(shè)置的單天發(fā)放限制額度,無法發(fā)放 | |
NOT_ENOUGH | 賬戶余額不足,請充值 | 商戶號余額不足,無法繼續(xù)發(fā)券,請充值 | |
RULE_LIMIT | 用戶已達(dá)最大領(lǐng)券次數(shù) | 該用戶已達(dá)到該批次的領(lǐng)取上限,請參考常見問題Q6 | |
RULE_LIMIT | 被自然人規(guī)則攔截 | 該自然人已達(dá)到該批次的領(lǐng)取上限,請參考常見問題Q6 | |
USER_ACCOUNT_ABNORMAL | 用戶非法 | 用戶命中微信支付風(fēng)控模型,請參考常見問題Q5 | |
REQUEST_BLOCKED | 商戶無權(quán)發(fā)券 | 該批次不支持其他商戶發(fā)放,請參考常見問題Q1 | |
REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次不支持其他商戶發(fā)放,請參考常見問題Q1 | |
REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 該用戶已達(dá)到該批次的領(lǐng)取上限,請參考常見問題Q6 | |
REQUEST_BLOCKED | 不能在api渠道發(fā)放 | 請檢查批次信息,僅支持發(fā)放微信支付代金券,不支持發(fā)放立減與折扣 | |
REQUEST_BLOCKED | 不支持指定面額發(fā)券 | 僅在發(fā)券時指定面額及門檻的場景才生效,常規(guī)發(fā)券場景請勿傳入該信息 | |
REQUEST_BLOCKED | 僅在廣告場景下發(fā)放批次 | 該批次已在朋友圈廣告發(fā)放,不支持在其他渠道發(fā)放 | |
404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請檢查批次及制券商戶號信息 |
429 | FREQUENCY_LIMIT_EXCEED | 接口限頻 | 請降低api調(diào)用頻率 |