最新更新時間：2021.1.22 版本說明
通過此接口可查詢代金券信息，包括代金券的基礎(chǔ)信息、狀態(tài)。如代金券已核銷，會包括代金券核銷的訂單信息（訂單號、單品信息等）。
適用對象：直連商戶 服務(wù)商 渠道商
請求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons/{coupon_id}
請求方式：GET
接口規(guī)則：http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請求URL傳參
body 指該參數(shù)需在請求JSON傳參
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 代金券id | coupon_id | string[1,20] | 是 | path 微信為代金券唯一分配的id。 示例值：9856888 |
| 公眾賬號ID | appid | string[1,128] | 是 | query 微信為發(fā)券方商戶分配的公眾賬號ID，接口傳入的所有appid應(yīng)該為公眾號的appid（在mp.weixin.qq.com申請的），不能為APP的appid（在open.weixin.qq.com申請的）。 示例值：wx233544546545989 |
| 用戶openid | openid | string[1,128] | 是 | path openid信息，用戶在appid下的唯一標(biāo)識。 示例值：2323dfsdf342342 |
https://api.mch.weixin.qq.com/v3/marketing/favor/users/2323dfsdf342342/coupons/985688?appid=wx233544546545989
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 創(chuàng)建批次的商戶號 | stock_creator_mchid | string[1,20] | 是 | 批次創(chuàng)建方商戶號 示例值：9800064 |
| 批次號 | stock_id | string[1,20] | 是 | 微信為每個代金券批次分配的唯一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：已實扣 EXPIRED：已過期 示例值：EXPIRED |
| 使用說明 | description | string[1,3000] | 是 | 代金券描述說明字段。 示例值：微信支付營銷 |
| 領(lǐng)券時間 | create_time | string[1,32] | 是 | 領(lǐng)券時間，遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss.sss表示時分秒毫秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領(lǐng)先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35.120+08:00表示，北京時間2015年5月20日 13點29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00 |
| 券類型 | coupon_type | string[1,16] |
是 | 券類型： NORMAL：滿減券 CUT_TO：減至券 示例值：CUT_TO |
| 是否無資金流 | no_cash | bool | 是 | 枚舉值： true：是 false：否 示例值：true |
| 可用開始時間 | available_begin_time | string[1,32] | 是 | 可用開始時間，遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss.sss表示時分秒毫秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領(lǐng)先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35.120+08:00表示，北京時間2015年5月20日 13點29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00 |
| 可用結(jié)束時間 | available_end_time | string[1,32] | 是 | 可用結(jié)束時間，遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss.sss表示時分秒毫秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領(lǐng)先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35.120+08:00表示，北京時間2015年5月20日 13點29分35秒。 示例值: 2015-05-20T13:29:35.120+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": "微信支付營銷",
"create_time": "2015-05-20T13:29:35.120+08:00",
"coupon_type": "CUT_TO",
"no_cash": null,
"available_begin_time": "2015-05-20T13:29:35.120+08:00",
"available_end_time": "2015-05-20T13:29:35.120+08:00",
"singleitem": null,
"normal_coupon_information": {
"coupon_amount": 100,
"transaction_minimum": 100
},
"consume_information": {
"consume_time": "2015-05-20T13:29:35.120+08:00",
"consume_mchid": "9856081",
"transaction_id": "2345234523",
"goods_detail": [
{
"goods_id": "a_goods1",
"quantity": 7,
"price": 1,
"discount_amount": 4
}
]
}
}
| 狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 回調(diào)url不能為空 | 請?zhí)顚懟卣{(diào)url |
| PARAM_ERROR | 回調(diào)商戶不能為空 | 請?zhí)顚懟卣{(diào)商戶 | |
| PARAM_ERROR | 券id必填 | 請?zhí)顚懭痠d | |
| PARAM_ERROR | appid必填 | 請輸入appid | |
| PARAM_ERROR | openid必填 | 請輸入openid | |
| PARAM_ERROR | 頁大小超過閾值 | 請不要超過最大的頁大小 | |
| PARAM_ERROR | 輸入時間格式錯誤 | 請輸入正確的時間格式 | |
| PARAM_ERROR | 批次號必填 | 請輸入批次號 | |
| PARAM_ERROR | 商戶號必填 | 請輸入商戶號 | |
| PARAM_ERROR | 非法的批次狀態(tài) | 請檢查批次狀態(tài) | |
| 400 | MCH_NOT_EXISTS | 商戶號不合法 | 請輸入正確的商戶號 |
| 400 | INVALID_REQUEST | openid與appID不匹配 | 請使用appID下的的openid |
| INVALID_REQUEST | 活動已結(jié)束或未激活 | 請檢查批次狀態(tài) | |
| INVALID_REQUEST | 非法的商戶號 | 請檢查商戶號是否正確 | |
| 400 | APPID_MCHID_NOT_MATCH | 商戶號與appid不匹配 | 請綁定調(diào)用接口的商戶號和APPID后重試 |
| 403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號異常，無法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
| 403 | NOT_ENOUGH | 批次預(yù)算不足 | 請補充預(yù)算 |
| 403 | REQUEST_BLOCKED | 調(diào)用商戶無權(quán)限 | 請開通產(chǎn)品權(quán)限后再調(diào)用該接口 |
| REQUEST_BLOCKED | 商戶無權(quán)發(fā)券 | 調(diào)用接口的商戶號無權(quán)發(fā)券，請檢查是否是自己的批次或是已授權(quán)的批次。 | |
| REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號的授權(quán)，請授權(quán)后再發(fā)放 | |
| REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 用戶領(lǐng)取已經(jīng)達(dá)到上限，請調(diào)高上限或停止發(fā)放。 | |
| 404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請檢查批次ID是否正確 |
| 429 | FREQUENCY_LIMIT_EXCEED | 接口限頻 | 請降低調(diào)用頻率 |