可通過該接口查詢用戶在某商戶號可用的全部券,可用于商戶的小程序/H5中,用戶"我的代金券"或"提交訂單頁"展示優(yōu)惠信息。無法查詢到微信支付立減金。本接口查不到用戶的微信支付立減金(又稱“全平臺通用券”),即在所有商戶都可以使用的券,例如:搖搖樂紅包;當(dāng)按可用商戶號查詢時,無法查詢用戶已經(jīng)核銷的券
接口頻率:不區(qū)分來源 2000/s 單ip 500/s
接口耗時:平均100ms以內(nèi)
冪等規(guī)則:接口支持冪等重入
# 接口說明
支持商戶:
【普通商戶】
請求方式:
【GET】/v3/marketing/favor/users/{openid}/coupons
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請設(shè)置為
application/json
Header HTTP頭參數(shù)
- openid 必填 string(128)【用戶標(biāo)識】 用戶在商戶appid下的唯一標(biāo)識。
校驗規(guī)則:該openid需要與接口傳入中的appid有對應(yīng)關(guān)系。
Path 路徑參數(shù)
- appid 必填 string(128)【公眾賬號ID】 微信為發(fā)券方商戶分配的公眾賬號ID,接口傳入的所有appid應(yīng)該為公眾號的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)管理) - stock_id 選填 string(20)【批次號】 批次號,是否指定批次號查詢,填寫available_mchid,該字段不生效。
- status 選填 string(6)【券或消費金狀態(tài)】 代金券或消費金狀態(tài):
選填creator_mchid時,
SENDED:返回可用
USED:返回可用+已實扣
選填available_mchid時,該字段不生效,僅返回 可用 狀態(tài)的券或消費金。 - creator_mchid 選填 string(20)【創(chuàng)建批次的商戶號】 批次創(chuàng)建方商戶號。請求參數(shù)傳創(chuàng)建商戶號返回除過期以外所有狀態(tài)的用戶券。creator_mchid與available_mchid二選一,如果同時存在,優(yōu)先使用creator_mchid。
- available_mchid 選填 string(20)【可用商戶號】 可用商戶號請求參數(shù)傳可用商戶號只能返回可用的代金券,實扣的與過期的無法返回。creator_mchid與available_mchid二選一,如果同時存在,優(yōu)先使用creator_mchid。
- offset 選填 integer【分頁頁碼】 分頁頁碼,默認(rèn)0,填寫available_mchid,該字段不生效
- limit 選填 integer【分頁大小】 分頁大小,默認(rèn)20,填寫available_mchid,該字段不生效
- business_type 選填 string【業(yè)務(wù)類型】 若選擇MULTIUSE,則僅返回查詢用戶擁有的消費金列表
枚舉值:
MULTIUSE:消費金
可選取值:MULTIUSE
: 消費金類型
Query 查詢參數(shù)
請求示例
GET
# 應(yīng)答參數(shù)
- data 選填 array[Coupon]【結(jié)果集】 結(jié)果集
- 屬性
- total_count 必填 integer【查詢結(jié)果總數(shù)】 查詢結(jié)果總數(shù)
- limit 必填 integer【分頁大小】 分頁大小
- offset 必填 integer【分頁頁碼】 分頁頁碼
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 | 驗證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | 商戶號與AppID不匹配 | 請綁定調(diào)用接口的商戶號和AppID后重試 |
400 | INVALID_REQUEST | OpenID與AppID不匹配 | 請使用AppID下的OpenID |
400 | INVALID_REQUEST | 活動已結(jié)束或未激活 | 請檢查批次狀態(tài) |
400 | INVALID_REQUEST | 非法的商戶號 | 請檢查商戶號是否正確 |
400 | MCH_NOT_EXISTS | 商戶號不合法 | 請輸入正確的商戶號 |
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 | 輸入時間格式錯誤 | 請輸入正確的時間格式 |
400 | PARAM_ERROR | 批次號必填 | 請輸入批次號 |
400 | PARAM_ERROR | 商戶號必填 | 請輸入商戶號 |
400 | PARAM_ERROR | 非法的批次狀態(tài) | 請檢查批次狀態(tài) |
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)用接口的商戶號無權(quán)發(fā)券,請檢查是否是自己的批次或是已授權(quán)的批次。 |
403 | REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號的授權(quán),請授權(quán)后再發(fā)放 |
403 | REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 用戶領(lǐng)取已經(jīng)達(dá)到上限,請調(diào)高上限或停止發(fā)放。 |
403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號異常,無法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請檢查批次ID是否正確 |
429 | FREQUENCY_LIMITED | 請求過于頻繁 | 稍后重試 |