查詢代金券信息
接口請求鏈接
https://api.mch.weixin.qq.com/mmpaymkttransfers/querycouponsinfo
請求參數(shù)
| 字段名 | 變量名 | 必填 | 示例值 | 類型 | 說明 |
|---|---|---|---|---|---|
| 代金券id | coupon_id | 是 | 1565 | String | 代金券id |
| 用戶openid | openid | 是 | onqOjjrXT-776SpHnfexGm1_P7iE | String | Openid信息，用戶在appid下的openid。 |
| 公眾賬號ID | appid | 是 | wx5edab3bdfba3dc1c | String(32) | 微信為發(fā)券方商戶分配的公眾賬號ID，接口傳入的所有appid應(yīng)該為公眾號的appid（在mp.weixin.qq.com申請的），不能為APP的appid（在open.weixin.qq.com申請的）。 |
| 商戶號 | mch_id | 是 | 10000098 | String(32) | 微信為發(fā)券方商戶分配的商戶號 |
| 批次號 | stock_id | 是 | 58818 | String(32) | 代金劵對應(yīng)的批次號 |
| 操作員 | op_user_id | 否 | 10000098 | String(32) | 操作員賬號, 默認(rèn)為商戶號 可在商戶平臺配置操作員對應(yīng)的api權(quán)限 |
| 設(shè)備號 | device_info | 否 | 013467007045764 | String(32) | 微信支付分配的終端設(shè)備號 |
| 隨機(jī)字符串 | nonce_str | 是 | 1417574675 | String(32) | 隨機(jī)字符串，不長于32位 |
| 簽名 | sign | 是 | 841B3002FE2220C87A2D08ABD8A8F791 | String(32) | 簽名參數(shù)，詳見簽名生成算法 |
| 協(xié)議版本 | version | 否 | 1.0 | String(32) | 默認(rèn)1.0 |
| 協(xié)議類型 | type | 否 | XML | String(32) | XML【目前僅支持默認(rèn)XML】 |
請求參數(shù)示例：
<xml>
<appid>121512345</appid>
<coupon_id>121512345456</coupon_id>
<mch_id>10010405</mch_id>
<nonce_str>1417575784</nonce_str>
<openid>onqOjjrXT-776SpHnfexGm1_P7iE</openid>
<sign>16F1415792512A5C340170B35F6C60E6</sign>
</xml>
返回參數(shù)
| 字段名 | 變量名 | 必填 | 示例值 | 類型 | 說明 |
|---|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | 是 | SUCCESS或者FAIL | String(16) | SUCCESS/FAIL 此字段是通信標(biāo)識，非交易標(biāo)識，交易是否成功需要查看result_code來判斷 |
| 返回信息 | return_msg | 否 | 成功：返回空 | String(128) | 返回信息，如非空，為通信錯(cuò)誤原因 |
| 公眾賬號ID | appid | 是 | wx5edab3bdfba3dc1c | String(32) | 微信為發(fā)券方商戶分配的公眾賬號ID，接口傳入的所有appid應(yīng)該為公眾號的appid（在mp.weixin.qq.com申請的），不能為APP的appid（在open.weixin.qq.com申請的）。 |
| 商戶號 | mch_id | 是 | 10000098 | String(32) | 微信為發(fā)券方商戶分配的商戶號 |
| 子商戶號 | sub_mch_id | 否 | 10000098 | String(32) | 微信支付分配的子商戶號，受理模式下必填 |
| 設(shè)備號 | device_info | 否 | 123456sb | String(32) | 微信支付分配的終端設(shè)備號， |
| 隨機(jī)字符串 | nonce_str | 是 | 1417574675 | String(32) | 隨機(jī)字符串，不長于32位 |
| 簽名 | sign | 是 | 841B3002FE2220C87A2D08ABD8A8F791 | String(32) | 簽名，詳見簽名生成算法 |
| 業(yè)務(wù)結(jié)果 | result_code | 是 | SUCCESS或者FAIL | String(16) | SUCCESS/FAIL |
| 錯(cuò)誤代碼 | err_code | 否 | PARAM_ERROR | String(32) | 詳見業(yè)務(wù)錯(cuò)誤代碼章節(jié) |
| 錯(cuò)誤代碼描述 | err_code_des | 否 | 錯(cuò)誤描述信息 | String(128) | 結(jié)果信息描述 |
| 批次ID | coupon_stock_id | 是 | 1567 | String | 代金券批次Id |
| 代金券id | coupon_id | 是 | 4242 | String | 代金券id |
| 代金券面額 | coupon_value | 是 | 4 | Unsinged int | 代金券面值,單位是分 |
| 代金券使用門檻 | coupon_minimum | 是 | 10 | Unsinged int | 代金券使用最低限額,單位是分 |
| 代金券名稱 | coupon_name | 是 | 測試代金券 | String | 代金券名稱 |
| 代金券狀態(tài) | coupon_state | 是 | SENDED | String | 代金券狀態(tài)：SENDED-可用，USED-已實(shí)扣，EXPIRED-已過期 |
| 代金券描述 | coupon_desc | 是 | 微信支付-代金券 | String | 代金券描述 |
| 實(shí)際優(yōu)惠金額 | coupon_use_value | 是 | 0 | Unsinged int | 代金券實(shí)際使用金額 |
| 優(yōu)惠剩余可用額 | coupon_remain_value | 是 | 4 | Unsinged int | 代金券剩余金額：部分使用情況下，可能會存在券剩余金額 |
| 發(fā)放來源 | send_source | 是 | FULL_SEND | String | 代金券發(fā)放來源：FULL_SEND-滿送 NORMAL-普通發(fā)放場景 |
| 是否允許部分使用 | is_partial_use | 否 | 1 | String | 該代金券是否允許部分使用標(biāo)識：1-表示支持部分使用 |
返回參數(shù)示例：
成功示例
<xml>
? <return_code>SUCCESS</return_code>
? <appid>wx5edab3bdfba3dc1c</appid>
? <mch_id>10000098</mch_id>
? <nonce_str>1417586982</nonce_str>
? <sign>841B3002FE2220C87A2D08ABD8A8F791</sign>
? <result_code>SUCCESS</result_code>
? <coupon_stock_id>1717</coupon_stock_id>
? <coupon_id>1442</coupon_id>
? <coupon_value>5</coupon_value>
? <coupon_minimum>10</coupon_minimum>
? <coupon_name>測試代金券</coupon_name>
? <coupon_state>SENDED</coupon_state>
? <coupon_desc>微信支付-代金券</coupon_desc>
? <coupon_use_value>0</coupon_use_value>
? <coupon_remain_value>5</coupon_remain_value>
? <send_source>FULL_SEND</send_source>
</xml>
? <return_code>SUCCESS</return_code>
? <appid>wx5edab3bdfba3dc1c</appid>
? <mch_id>10000098</mch_id>
? <nonce_str>1417586982</nonce_str>
? <sign>841B3002FE2220C87A2D08ABD8A8F791</sign>
? <result_code>SUCCESS</result_code>
? <coupon_stock_id>1717</coupon_stock_id>
? <coupon_id>1442</coupon_id>
? <coupon_value>5</coupon_value>
? <coupon_minimum>10</coupon_minimum>
? <coupon_name>測試代金券</coupon_name>
? <coupon_state>SENDED</coupon_state>
? <coupon_desc>微信支付-代金券</coupon_desc>
? <coupon_use_value>0</coupon_use_value>
? <coupon_remain_value>5</coupon_remain_value>
? <send_source>FULL_SEND</send_source>
</xml>
失敗示例
<xml>
? <return_code>SUCCESS</return_code>
? <appid>wx5edab3bdfba3dc1c</appid>
? <mch_id>10000098</mch_id>
? <nonce_str>1417586982</nonce_str>
? <sign>841B3002FE2220C87A2D08ABD8A8F791</sign>
? <result_code>SUCCESS</result_code>
? <err_code>PARAM_ERROR</err_code>
? <err_code_des>你已領(lǐng)取過包</err_code_des>
? <coupon_stock_id>1717</coupon_stock_id>
? <coupon_id>1442</coupon_id>
? <coupon_value>5</coupon_value>
? <coupon_mininum>10</coupon_mininum>
? <coupon_name>測試代金券</coupon_name>
? <coupon_state>USED</coupon_state>
? <coupon_desc>微信支付-代金券</coupon_desc>
? <coupon_use_value>0</coupon_use_value>
? <coupon_remain_value>5</coupon_remain_value>
? <send_source>FULL_SEND</send_source>
</xml>
? <return_code>SUCCESS</return_code>
? <appid>wx5edab3bdfba3dc1c</appid>
? <mch_id>10000098</mch_id>
? <nonce_str>1417586982</nonce_str>
? <sign>841B3002FE2220C87A2D08ABD8A8F791</sign>
? <result_code>SUCCESS</result_code>
? <err_code>PARAM_ERROR</err_code>
? <err_code_des>你已領(lǐng)取過包</err_code_des>
? <coupon_stock_id>1717</coupon_stock_id>
? <coupon_id>1442</coupon_id>
? <coupon_value>5</coupon_value>
? <coupon_mininum>10</coupon_mininum>
? <coupon_name>測試代金券</coupon_name>
? <coupon_state>USED</coupon_state>
? <coupon_desc>微信支付-代金券</coupon_desc>
? <coupon_use_value>0</coupon_use_value>
? <coupon_remain_value>5</coupon_remain_value>
? <send_source>FULL_SEND</send_source>
</xml>
錯(cuò)誤碼
| 錯(cuò)誤代碼 | 描述 | 解決方案 |
|---|---|---|
| COUPON_NOT_FOUND | 券沒有查找成功 | 確認(rèn)券id、用戶openid的正確性 |
| SIGN_ERROR | 簽名錯(cuò)誤 | 驗(yàn)證簽名有誤 |
| COUPON_STOCK_ID_NOT_VALID | 批次id不正確 | 確認(rèn)批次id正確性以及和商戶id的所屬關(guān)系是否正確 |
| REQ_PARAM_XML_ERR | 輸入的參數(shù)xml格式有誤 | 檢查輸入的xml格式是否正確 |
| COUPON_STOCK_ID_EMPTY | 批次id為空 | 確認(rèn)批次id正確傳入 |
| MCH_ID_EMPTY | 商戶id為空 | 確認(rèn)商戶id正確傳入 |
| CODE_2_ID_ERR | 商戶id有誤 | 確認(rèn)商戶id是否正確并合法 |
| GET_COUPON_STOCK_FAIL | 獲取批次信息失敗 | 確認(rèn)批次id信息正確 |
| COUPON_STOCK_NOT_FOUND | 批次信息不存在 | 確認(rèn)批次id信息正確 |