通過此接口可查詢代金券信息,包括代金券的基礎(chǔ)信息、狀態(tài)。
注意: ??該接口支持批次創(chuàng)建商戶號(hào)與批次發(fā)放商戶調(diào)用
接口頻率:不區(qū)分來源?1000/s,?單ip?500/s
接口耗時(shí):1S
冪等規(guī)則:接口支持冪等重入
# 接口說明
支持商戶:
【普通商戶】
請(qǐng)求方式:
【GET】/v3/marketing/favor/users/{openid}/coupons/{coupon_id}
請(qǐng)求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點(diǎn) ,指引點(diǎn)擊查看
# 請(qǐng)求參數(shù)
- Authorization 必填 string請(qǐng)參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請(qǐng)?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- coupon_id 必填 string(20)【代金券或消費(fèi)金id】 微信為代金券或消費(fèi)金唯一分配的id。發(fā)放代金券API返回的數(shù)據(jù)
- openid 必填 string(128)【用戶openid】 openid是微信用戶在appid下的唯一用戶標(biāo)識(shí)(appid不同,則獲取到的openid就不同),可用于永久標(biāo)記一個(gè)用戶。
獲取openid的方式
Path 路徑參數(shù)
- appid 必填 string(128)【公眾賬號(hào)ID 】 微信為調(diào)用商戶分配的公眾賬號(hào)ID,接口傳入的appid應(yīng)該為公眾號(hào)的appid和小程序的appid(在微信公眾平臺(tái)
申請(qǐng))或APP的appid(在微信開發(fā)平臺(tái) 申請(qǐng))。
校驗(yàn)規(guī)則:
1、該appid需要與接口傳入中的openid有對(duì)應(yīng)關(guān)系;
2、該appid需要與調(diào)用接口的商戶號(hào)(即請(qǐng)求頭中的商戶號(hào))有綁定關(guān)系,若未綁定,可參考該指引完成綁定 (商家商戶號(hào)與AppID賬號(hào)關(guān)聯(lián)管理)
Query 查詢參數(shù)
請(qǐng)求示例
GET
# 應(yīng)答參數(shù)
- stock_creator_mchid 必填 string【創(chuàng)建批次的商戶號(hào)】 微信為創(chuàng)建方商戶分配的商戶號(hào)
- stock_id 必填 string【批次號(hào)】 微信為每個(gè)代金券批次分配的唯一id。
- coupon_id 必填 string【代金券或消費(fèi)金id】 微信為代金券或消費(fèi)金唯一分配的id
- cut_to_message 選填 CutTypeMsg【單品優(yōu)惠特定信息】 單品優(yōu)惠特定信息
- 屬性
- coupon_name 必填 string【券或消費(fèi)金名稱】 券或消費(fèi)金名稱
- status 必填 string【券或消費(fèi)金狀態(tài)】 券或消費(fèi)金狀態(tài):
SENDED:可用
USED:已實(shí)扣
EXPIRED:已過期 - description 必填 string【使用說明】 券或消費(fèi)金描述說明字段
- create_time 必填 string【領(lǐng)券時(shí)間】 領(lǐ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秒。 - coupon_type 必填 string【券或消費(fèi)金類型】 券或消費(fèi)金類型:
NORMAL:滿減券
CUT_TO:減至券 - no_cash 必填 boolean【是否無資金流】 枚舉值:
true:是
false:否 - available_begin_time 必填 string【可用開始時(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秒。 - available_end_time 必填 string【可用結(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秒。 - singleitem 必填 boolean【是否單品優(yōu)惠】 枚舉值:
true:是
false:否 - normal_coupon_information 選填 FixedValueStockMsg【滿減券或消費(fèi)金信息】 普通滿減券或消費(fèi)金面額、門檻信息。
- 屬性
- out_request_no 選填 string【商戶單據(jù)號(hào)】 商戶此次發(fā)放憑據(jù)號(hào)
- available_balance 選填 integer【剩余金額】 可用余額,單位:分。
僅有當(dāng)business_type=MULTIUSE時(shí),才會(huì)返回。 - business_type 選填 string【業(yè)務(wù)類型】 細(xì)分業(yè)務(wù)類型,僅當(dāng)business_type=MULTIUSE時(shí)才返回,枚舉值:
MULTIUSE:消費(fèi)金
可選取值:MULTIUSE
: 消費(fèi)金類型
200OK
應(yīng)答示例
200 OK
# 錯(cuò)誤碼
# 公共錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)根據(jù)錯(cuò)誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請(qǐng)求不符合微信支付 APIv3 接口規(guī)則 | 請(qǐng)參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗(yàn)證不通過 | 請(qǐng)參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請(qǐng)稍后重試 | 請(qǐng)稍后重試 |
# 業(yè)務(wù)錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | 商戶號(hào)與AppID不匹配 | 請(qǐng)綁定調(diào)用接口的商戶號(hào)和AppID后重試 |
400 | INVALID_REQUEST | OpenID與AppID不匹配 | 請(qǐng)使用AppID下的OpenID |
400 | INVALID_REQUEST | 活動(dòng)已結(jié)束或未激活 | 請(qǐng)檢查批次狀態(tài) |
400 | INVALID_REQUEST | 非法的商戶號(hào) | 請(qǐng)檢查商戶號(hào)是否正確 |
400 | MCH_NOT_EXISTS | 商戶號(hào)不合法 | 請(qǐng)輸入正確的商戶號(hào) |
400 | PARAM_ERROR | 回調(diào)URL不能為空 | 請(qǐng)?zhí)顚懟卣{(diào)URL |
400 | PARAM_ERROR | 回調(diào)商戶不能為空 | 請(qǐng)?zhí)顚懟卣{(diào)商戶 |
400 | PARAM_ERROR | 券ID必填 | 請(qǐng)?zhí)顚懭疘D |
400 | PARAM_ERROR | AppID必填 | 請(qǐng)輸入AppID |
400 | PARAM_ERROR | OpenID必填 | 請(qǐng)輸入OpenID |
400 | PARAM_ERROR | 頁大小超過閾值 | 請(qǐng)不要超過最大的頁大小 |
400 | PARAM_ERROR | 輸入時(shí)間格式錯(cuò)誤 | 請(qǐng)輸入正確的時(shí)間格式 |
400 | PARAM_ERROR | 批次號(hào)必填 | 請(qǐng)輸入批次號(hào) |
400 | PARAM_ERROR | 商戶號(hào)必填 | 請(qǐng)輸入商戶號(hào) |
400 | PARAM_ERROR | 非法的批次狀態(tài) | 請(qǐng)檢查批次狀態(tài) |
403 | NOT_ENOUGH | 批次預(yù)算不足 | 請(qǐng)補(bǔ)充預(yù)算 |
403 | REQUEST_BLOCKED | 調(diào)用商戶無權(quán)限 | 請(qǐng)開通產(chǎn)品權(quán)限后再調(diào)用該接口 |
403 | REQUEST_BLOCKED | 商戶無權(quán)發(fā)券 | 調(diào)用接口的商戶號(hào)無權(quán)發(fā)券,請(qǐng)檢查是否是自己的批次或是已授權(quán)的批次。 |
403 | REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號(hào)的授權(quán),請(qǐng)授權(quán)后再發(fā)放 |
403 | REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 用戶領(lǐng)取已經(jīng)達(dá)到上限,請(qǐng)調(diào)高上限或停止發(fā)放。 |
403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號(hào)異常,無法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請(qǐng)檢查批次ID是否正確 |
429 | FREQUENCY_LIMIT_EXCEED | 接口限頻 | 請(qǐng)降低調(diào)用頻率 |
429 | FREQUENCY_LIMITED | 請(qǐng)求過于頻繁 | 稍后重試 |