最新更新時(shí)間：2021.1.22 版本說明
通過此接口可查詢代金券信息，包括代金券的基礎(chǔ)信息、狀態(tài)。
? 該接口支持批次創(chuàng)建商戶號(hào)與批次發(fā)放商戶調(diào)用
適用對(duì)象：直連商戶
接口頻率：不區(qū)分來源 1000/s， 單ip 500/s
接口耗時(shí)：1S
冪等規(guī)則：接口支持冪等重入
請(qǐng)求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons/{coupon_id}
請(qǐng)求方式：GET
path指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請(qǐng)求URL傳參
body 指該參數(shù)需在請(qǐng)求JSON傳參
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 代金券id | coupon_id | string[1,20] | 是 | path 微信為代金券唯一分配的id。 發(fā)放代金券API返回的數(shù)據(jù) 示例值：9856888 |
| 公眾賬號(hào)ID | appid | string[1,128] | 是 | query微信為調(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)管理） 示例值：wx233544546545989 |
| 用戶openid | openid | string[1,128] | 是 | pathopenid是微信用戶在appid下的唯一用戶標(biāo)識(shí)（appid不同，則獲取到的openid就不同），可用于永久標(biāo)記一個(gè)用戶。 獲取openid的方式 示例值：2323dfsdf342342 |
https://api.mch.weixin.qq.com/v3/marketing/favor/users/2323dfsdf342342/coupons/985688?appid=wx233544546545989
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 創(chuàng)建批次的商戶號(hào) | stock_creator_mchid | string[1,20] | 是 | 批次創(chuàng)建方商戶號(hào) 示例值：9800064 |
| 批次號(hào) | stock_id | string[1,20] | 是 | 微信為每個(gè)代金券批次分配的唯一id。 示例值：9865888 |
| 代金券id | coupon_id | string[1,20] | 是 | 微信為代金券唯一分配的id。 示例值：98674556 |
| + 單品優(yōu)惠特定信息 | cut_to_message | object |
否 | 單品優(yōu)惠特定信息。 |
| 代金券名稱 | coupon_name | string[1,20] | 是 | 代金券名稱 示例值：微信支付代金券 |
| 代金券狀態(tài) | status | string[1,16] |
是 | 代金券狀態(tài)： SENDED：可用 USED：已實(shí)扣 EXPIRED：已過期 示例值：EXPIRED |
| 使用說明 | description | string[1,3000] | 是 | 代金券描述說明字段。 示例值：微信支付營(yíng)銷 |
| 領(lǐng)券時(shí)間 | create_time | string[1,32] | 是 | 領(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秒。 示例值: 2015-05-20T13:29:35+08:00 |
| 券類型 | coupon_type | string[1,16] |
是 | 券類型： NORMAL：滿減券 CUT_TO：減至券 示例值：CUT_TO |
| 是否無資金流 | no_cash | bool | 是 | 枚舉值： true：是 false：否 示例值：true |
| 可用開始時(shí)間 | available_begin_time | string[1,32] | 是 | 可用開始時(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秒。 示例值: 2015-05-20T13:29:35+08:00 |
| 可用結(jié)束時(shí)間 | available_end_time | string[1,32] | 是 | 可用結(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秒。 示例值: 2015-05-20T13:29:35+08:00 |
| 是否單品優(yōu)惠 | singleitem | bool | 是 | 枚舉值： true：是 false：否 示例值：true |
| + 滿減券信息 | normal_coupon_information | object |
否 | 普通滿減券面額、門檻信息。 |
{
"stock_creator_mchid": "9800064",
"stock_id": "9865888",
"coupon_id": "98674556",
"cut_to_message": {
"single_price_max": 100,
"cut_to_price":100
},
"coupon_name": "微信支付代金券",
"status": "EXPIRED",
"description": "微信支付營(yíng)銷",
"create_time": "2015-05-20T13:29:35+08:00",
"coupon_type": "CUT_TO",
"no_cash": true,
"available_begin_time": "2015-05-20T13:29:35+08:00",
"available_end_time": "2015-05-20T13:29:35+08:00",
"singleitem": true,
"normal_coupon_information": {
"coupon_amount": 100,
"transaction_minimum": 100
}
}
| 狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 回調(diào)url不能為空 | 請(qǐng)?zhí)顚懟卣{(diào)url |
| PARAM_ERROR | 回調(diào)商戶不能為空 | 請(qǐng)?zhí)顚懟卣{(diào)商戶 | |
| PARAM_ERROR | 券id必填 | 請(qǐng)?zhí)顚懭痠d | |
| PARAM_ERROR | appid必填 | 請(qǐng)輸入appid | |
| PARAM_ERROR | openid必填 | 請(qǐng)輸入openid | |
| PARAM_ERROR | 頁大小超過閾值 | 請(qǐng)不要超過最大的頁大小 | |
| PARAM_ERROR | 輸入時(shí)間格式錯(cuò)誤 | 請(qǐng)輸入正確的時(shí)間格式 | |
| PARAM_ERROR | 批次號(hào)必填 | 請(qǐng)輸入批次號(hào) | |
| PARAM_ERROR | 商戶號(hào)必填 | 請(qǐng)輸入商戶號(hào) | |
| PARAM_ERROR | 非法的批次狀態(tài) | 請(qǐng)檢查批次狀態(tài) | |
| 400 | MCH_NOT_EXISTS | 商戶號(hào)不合法 | 請(qǐng)輸入正確的商戶號(hào) |
| 400 | INVALID_REQUEST | openid與appid不匹配 | 請(qǐng)使用appid下的openid |
| INVALID_REQUEST | 活動(dòng)已結(jié)束或未激活 | 請(qǐng)檢查批次狀態(tài) | |
| INVALID_REQUEST | 非法的商戶號(hào) | 請(qǐng)檢查商戶號(hào)是否正確 | |
| 400 | APPID_MCHID_NOT_MATCH | 商戶號(hào)與appid不匹配 | 請(qǐng)綁定調(diào)用接口的商戶號(hào)和appid后重試 |
| 403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號(hào)異常，無法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
| 403 | NOT_ENOUGH | 批次預(yù)算不足 | 請(qǐng)補(bǔ)充預(yù)算 |
| 403 | REQUEST_BLOCKED | 調(diào)用商戶無權(quán)限 | 請(qǐng)開通產(chǎn)品權(quán)限后再調(diào)用該接口 |
| REQUEST_BLOCKED | 商戶無權(quán)發(fā)券 | 調(diào)用接口的商戶號(hào)無權(quán)發(fā)券，請(qǐng)檢查是否是自己的批次或是已授權(quán)的批次。 | |
| REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號(hào)的授權(quán)，請(qǐng)授權(quán)后再發(fā)放 | |
| REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 用戶領(lǐng)取已經(jīng)達(dá)到上限，請(qǐng)調(diào)高上限或停止發(fā)放。 | |
| 404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請(qǐng)檢查批次ID是否正確 |
| 429 | FREQUENCY_LIMIT_EXCEED | 接口限頻 | 請(qǐng)降低調(diào)用頻率 |
| 429 | FREQUENCY_LIMITED | 請(qǐng)求過于頻繁 | 稍后重試 |