最新更新時間：2019.09.29 版本說明
可通過該接口查詢用戶在某商戶號可用的全部券，可用于商戶的小程序/H5中，用戶"我的代金券"或"提交訂單頁"展示優(yōu)惠信息。無法查詢到微信支付立減金。本接口查不到用戶的微信支付立減金（又稱“全平臺通用券”），即在所有商戶都可以使用的券，例如：搖搖樂紅包；當按可用商戶號查詢時，無法查詢用戶已經核銷的券
適用對象：直連商戶 服務商 渠道商
請求URL：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons
請求方式：GET
接口規(guī)則：http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path指該參數為路徑參數
query 指該參數需在請求URL傳參
body 指該參數需在請求JSON傳參
| 參數名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 用戶標識 | openid | string[1,128] | 是 | path 用戶在商戶appid 下的唯一標識。 示例值：2323dfsdf342342 |
| 公眾賬號ID | appid | string[1,128] | 是 | query 微信為發(fā)券方商戶分配的公眾賬號ID，接口傳入的所有appid應該為公眾號的appid（在mp.weixin.qq.com申請的），不能為APP的appid（在open.weixin.qq.com申請的）。 示例值：wx233544546545989 |
| 批次號 | stock_id | string[1,20] | 否 | query 批次號，是否指定批次號查詢，填寫available_mchid，該字段不生效。 示例值：9865000 |
| 券狀態(tài) | status | string[1,6] | 否 | query 代金券狀態(tài)： SENDED：可用 USED：已實扣 填寫available_mchid，該字段不生效。 示例值：USED |
| 創(chuàng)建批次的商戶號 | creator_mchid | string[1,20] | 否 | query 批次創(chuàng)建方商戶號。 示例值：9865002 |
| 批次發(fā)放商戶號 | sender_mchid | string[1,20] | 否 | query 批次發(fā)放商戶號 示例值：9865001 |
| 可用商戶號 | available_mchid | string[1,20] | 否 | query 可用商戶號 示例值: 9865000 |
| 分頁頁碼 | offset | uint32 | 否 | query 分頁頁碼，默認0，填寫available_mchid，該字段不生效。 示例值：0 |
| 分頁大小 | limit | uint32 | 否 | query 分頁大小，默認20，填寫available_mchid，該字段不生效。 示例值：20 |
https://api.mch.weixin.qq.com/v3/marketing/favor/users/2323dfsdf342342/coupons？appid=wx233544546545989
| 參數名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| +結果集 | data | object |
否 | 結果集 |
| 查詢結果總數 | total_count | uint32 | 是 | 查詢結果總數 示例值：100 |
| 分頁大小 | limit | uint32 | 是 | 分頁大小 示例值：10 |
| 分頁頁碼 | offset | uint32 | 是 | 分頁頁碼 示例值：10 |
{
"data": [{
"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
}]
}
}]
"total_count": 100,
"limit": 10,
"offset": 10,
}
| 狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 回調url不能為空 | 請?zhí)顚懟卣{url |
| PARAM_ERROR | 回調商戶不能為空 | 請?zhí)顚懟卣{商戶 | |
| 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 | 活動已結束或未激活 | 請檢查批次狀態(tài) | |
| INVALID_REQUEST | 非法的商戶號 | 請檢查商戶號是否正確 | |
| 400 | APPID_MCHID_NOT_MATCH | 商戶號與appid不匹配 | 請綁定調用接口的商戶號和APPID后重試 |
| 403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號異常，無法領券。商家可聯系微信支付或讓用戶聯系微信支付客服處理。 |
| 403 | NOT_ENOUGH | 批次預算不足 | 請補充預算 |
| 403 | REQUEST_BLOCKED | 調用商戶無權限 | 請開通產品權限后再調用該接口 |
| REQUEST_BLOCKED | 商戶無權發(fā)券 | 調用接口的商戶號無權發(fā)券，請檢查是否是自己的批次或是已授權的批次。 | |
| REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號的授權，請授權后再發(fā)放 | |
| REQUEST_BLOCKED | 用戶被限領攔截 | 用戶領取已經達到上限，請調高上限或停止發(fā)放。 | |
| 404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請檢查批次ID是否正確 |
| 429 | FREQUENCY_LIMIT_EXCEED | 接口限頻 | 請降低調用頻率 |