查詢代金券批次
接口請求鏈接
https://api.mch.weixin.qq.com/mmpaymkttransfers/query_coupon_stock
是否需要證書
不需要。
請求參數(shù)
字段名 | 變量名 | 必填 | 示例值 | 類型 | 說明 |
---|---|---|---|---|---|
代金券批次id | coupon_stock_id | 是 | 1757 | String | 代金券批次id |
公眾賬號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ā)券方商戶分配的商戶號 |
操作員 | op_user_id | 否 | 10000098 | String(32) | 操作員賬號, 默認為商戶號 可在商戶平臺配置操作員對應(yīng)的api權(quán)限 |
設(shè)備號 | device_info | 否 | 013467007045764 | String(32) | 微信支付分配的終端設(shè)備號 |
隨機字符串 | nonce_str | 是 | 1417574675 | String(32) | 隨機字符串,不長于32位 |
簽名 | sign | 是 | 841B3002FE2220C87A2D08ABD8A8F791 | String(32) | 簽名參數(shù),詳見簽名生成算法 |
協(xié)議版本 | version | 否 | 1.0 | String(32) | 默認1.0 |
協(xié)議類型 | type | 否 | XML | String(32) | XML【目前僅支持默認XML】 |
請求參數(shù)示例:
<xml>
<appid>121512345</appid>
<coupon_stock_id>1757</coupon_stock_id>
<mch_id>10000098</mch_id>
<nonce_str>1417575000</nonce_str>
<sign>BBB998301C99F96F41E6EA727ADFC45D</sign>
</xml>
返回參數(shù)
字段名 | 變量名 | 必填 | 示例值 | 類型 | 說明 |
---|---|---|---|---|---|
返回狀態(tài)碼 | return_code | 是 | SUCCESS或者FAIL | String(16) | SUCCESS/FAIL 此字段是通信標識,非交易標識,交易是否成功需要查看result_code來判斷 |
返回信息 | return_msg | 否 | 成功:返回空 | String(128) | 返回信息,如非空,為通信錯誤原因 |
公眾賬號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ā)券方商戶分配的商戶號 |
設(shè)備號 | device_info | 否 | 123456sb | String(32) | 微信支付分配的終端設(shè)備號, |
隨機字符串 | nonce_str | 是 | 1417574675 | String(32) | 隨機字符串,不長于32位 |
業(yè)務(wù)結(jié)果 | result_code | 是 | SUCCESS或者FAIL | String(16) | SUCCESS/FAIL |
錯誤代碼 | err_code | 否 | COUPON_STOCK_ID_NOT_VALID | String(32) | 詳見業(yè)務(wù)錯誤代碼章節(jié) |
錯誤代碼描述 | err_code_des | 否 | 錯誤描述信息 | String(128) | 結(jié)果信息描述 |
代金券批次ID | coupon_stock_id | 是 | 1757 | String | 代金券批次Id |
代金券名稱 | coupon_name | 否 | 測試代金券 | String | 代金券名稱 |
代金券面額 | coupon_value | 是 | 5 | Unsinged int | 代金券面值,單位是分 |
代金券使用最低限額 | coupon_mininumn | 否 | 10 | Unsinged int | 代金券使用最低限額,單位是分 |
代金券批次狀態(tài) | coupon_stock_status | 是 | 4 | int | 批次狀態(tài): 1-未激活;2-審批中;4-已激活;8-已作廢;16-中止發(fā)放; |
代金券數(shù)量 | coupon_total | 是 | 100 | Unsigned int | 代金券數(shù)量 |
代金券最大領(lǐng)取數(shù)量 | max_quota | 否 | 1 | Unsigned int | 代金券每個人最多能領(lǐng)取的數(shù)量, 如果為0,則表示沒有限制 |
代金券已經(jīng)發(fā)送的數(shù)量 | is_send_num | 否 | 0 | Unsigned int | 代金券已經(jīng)發(fā)送的數(shù)量 |
生效開始時間 | begin_time | 是 | 1943787483 | String | 格式為時間戳 |
生效結(jié)束時間 | end_time | 是 | 1943787490 | String | 格式為時間戳 |
創(chuàng)建時間 | create_time | 是 | 1943787420 | String | 格式為時間戳 |
代金券預(yù)算額度 | coupon_budget | 否 | 500 | Unsigned int | 代金券預(yù)算額度 |
生效開始時間 | begin_time_t | 是 | 20181126152401 | String | 格式為年月日時間制 |
生效結(jié)束時間 | end_time_t | 是 | 20181126152401 | String | 格式為年月日時間制 |
創(chuàng)建時間 | create_time_t | 是 | 20181126152401 | String | 格式為年月日時間制 |
返回參數(shù)示例:
成功示例
? <appid>wx5edab3bdfba3dc1c</appid>
? <mch_id>10000098</mch_id>
? <nonce_str>1417583379</nonce_str>
? <sign>841B3002FE2220C87A2D08ABD8A8F791</sign>
? <result_code>SUCCESS</result_code>
? <coupon_stock_id>1717</coupon_stock_id>
? <coupon_value>5</coupon_value>
? <coupon_mininumn>10</coupon_mininumn>
? <coupon_stock_status>4</coupon_stock_status>
? <coupon_total>100</coupon_total>
? <coupon_budget>500</coupon_budget>
</xml>
失敗示例
<xml>
<return_code>SUCCESS</return_code>
<appid>wx5edab3bdfba3dc1c</appid>
<mch_id>10000098</mch_id>
<nonce_str>1417583379</nonce_str>
<sign>841B3002FE2220C87A2D08ABD8A8F791</sign>
<result_code>SUCCESS</result_code>
<err_code>268456007</err_code>
<err_code_des>批次ID信息不正確</err_code_des>
<coupon_stock_id>1717</coupon_stock_id>
</xml>
錯誤碼
錯誤代碼 | 描述 | 解決方案 |
---|---|---|
COUPON_STOCK_ID_NOT_VALID | 批次id不正確 | 確認批次id正確性,以及和商戶id所屬關(guān)系是否正確 |
SIGN_ERROR | 簽名錯誤 | 驗證簽名有誤 |
REQ_PARAM_XML_ERR | 輸入?yún)?shù)xml格式有誤 | 檢查入?yún)⒌膞ml格式是否正確 |
COUPON_STOCK_ID_EMPTY | 批次ID為空 | 確保批次id正確傳入 |
MCH_ID_EMPTY | 商戶ID為空 | 確保商戶id正確傳入 |
CODE_2_ID_ERR | 商戶id有誤 | 檢查商戶id是否正確并合法 |
GET_COUPON_STOCK_FAIL | 獲取批次信息失敗 | 確認批次id信息正確 |
COUPON_STOCK_NOT_FOUND | 批次信息不存在 | 確認批次id信息正確 |