通過(guò)此接口可查詢多個(gè)批次的信息,包括批次的配置信息以及批次概況數(shù)據(jù)。
接口頻率:不區(qū)分來(lái)源 1000/s 單ip 500/s
接口耗時(shí):1S
冪等規(guī)則:接口支持冪等重入
# 接口說(shuō)明
支持商戶:
【普通服務(wù)商】【從業(yè)機(jī)構(gòu)(銀行)】【從業(yè)機(jī)構(gòu)(支付機(jī)構(gòu))】【渠道商】【清算機(jī)構(gòu)】
請(qǐng)求方式:
【GET】/v3/marketing/favor/stocks
請(qǐng)求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問(wèn)就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問(wèn)異地的接入點(diǎn) ,指引點(diǎn)擊查看
# 請(qǐng)求參數(shù)
- Authorization 必填 string請(qǐng)參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請(qǐng)?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- offset 必填 integer【分頁(yè)頁(yè)碼】 頁(yè)碼從0開(kāi)始,默認(rèn)第0頁(yè)
- limit 必填 integer【分頁(yè)大小】 分頁(yè)大小,最大10
- stock_creator_mchid 必填 string(20)【創(chuàng)建批次的商戶號(hào)】 批次創(chuàng)建方商戶號(hào)。
校驗(yàn)規(guī)則:接口傳入的批次號(hào)需由stock_creator_mchid所創(chuàng)建。 - create_start_time 選填 string(64)【起始時(shí)間】 起始創(chuàng)建時(shí)間,遵循rfc3339
標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,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秒。
校驗(yàn)規(guī)則:get請(qǐng)求,參數(shù)在 url中,需要進(jìn)行 url 編碼傳遞 - create_end_time 選填 string(664)【終止時(shí)間】 終止創(chuàng)建時(shí)間,遵循rfc3339
標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開(kāi)頭,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秒。
校驗(yàn)規(guī)則:get請(qǐng)求,參數(shù)在 url中,需要進(jìn)行 url 編碼傳遞 - status 選填 string(12)【批次狀態(tài)】 批次狀態(tài),枚舉值:
unactivated:未激活
audit:審核中
running:運(yùn)行中
stoped:已停止
paused:暫停發(fā)放
Query 查詢參數(shù)
請(qǐng)求示例
GET
# 應(yīng)答參數(shù)
- total_count 必填 integer【批次總數(shù)】 經(jīng)過(guò)條件篩選,查詢到的批次總數(shù)量。
- data 選填 array[Stock]【批次詳情】 批次詳情
- 屬性
- limit 必填 integer【分頁(yè)大小】 分頁(yè)大小,最大10
- offset 必填 integer【分頁(yè)頁(yè)碼】 頁(yè)碼從0開(kāi)始,默認(rèn)第0頁(yè)
200OK
應(yīng)答示例
200 OK
# 錯(cuò)誤碼
# 公共錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)根據(jù)錯(cuò)誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請(qǐng)求不符合微信支付 APIv3 接口規(guī)則 | 請(qǐng)參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗(yàn)證不通過(guò) | 請(qǐng)參閱 簽名常見(jiàn)問(wèn)題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請(qǐng)稍后重試 | 請(qǐng)稍后重試 |
# 業(yè)務(wù)錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | APPID_MCHID_NOT_MATCH | 商戶號(hào)與AppID不匹配 | 請(qǐng)綁定調(diào)用接口的商戶號(hào)和AppID后重試 |
400 | INVALID_REQUEST | OpenID與AppID不匹配 | 請(qǐng)使用AppID下的OpenID |
400 | INVALID_REQUEST | 活動(dòng)已結(jié)束或未激活 | 請(qǐng)檢查批次狀態(tài) |
400 | INVALID_REQUEST | 非法的商戶號(hào) | 請(qǐng)檢查商戶號(hào)是否正確 |
400 | MCH_NOT_EXISTS | 商戶號(hào)不合法 | 請(qǐng)輸入正確的商戶號(hào) |
400 | PARAM_ERROR | 回調(diào)URL不能為空 | 請(qǐng)?zhí)顚?xiě)回調(diào)URL |
400 | PARAM_ERROR | 回調(diào)商戶不能為空 | 請(qǐng)?zhí)顚?xiě)回調(diào)商戶 |
400 | PARAM_ERROR | 券ID必填 | 請(qǐng)?zhí)顚?xiě)券ID |
400 | PARAM_ERROR | AppID必填 | 請(qǐng)輸入AppID |
400 | PARAM_ERROR | OpenID必填 | 請(qǐng)輸入OpenID |
400 | PARAM_ERROR | 頁(yè)大小超過(guò)閾值 | 請(qǐng)不要超過(guò)最大的頁(yè)大小 |
400 | PARAM_ERROR | 輸入時(shí)間格式錯(cuò)誤 | 請(qǐng)輸入正確的時(shí)間格式 |
400 | PARAM_ERROR | 批次號(hào)必填 | 請(qǐng)輸入批次號(hào) |
400 | PARAM_ERROR | 商戶號(hào)必填 | 請(qǐng)輸入商戶號(hào) |
400 | PARAM_ERROR | 非法的批次狀態(tài) | 請(qǐng)檢查批次狀態(tài) |
403 | NOT_ENOUGH | 批次預(yù)算不足 | 請(qǐng)補(bǔ)充預(yù)算 |
403 | REQUEST_BLOCKED | 調(diào)用商戶無(wú)權(quán)限 | 請(qǐng)開(kāi)通產(chǎn)品權(quán)限后再調(diào)用該接口 |
403 | REQUEST_BLOCKED | 商戶無(wú)權(quán)發(fā)券 | 調(diào)用接口的商戶號(hào)無(wú)權(quán)發(fā)券,請(qǐng)檢查是否是自己的批次或是已授權(quán)的批次。 |
403 | REQUEST_BLOCKED | 批次不支持跨商戶發(fā)券 | 該批次未做跨商戶號(hào)的授權(quán),請(qǐng)授權(quán)后再發(fā)放 |
403 | REQUEST_BLOCKED | 用戶被限領(lǐng)攔截 | 用戶領(lǐng)取已經(jīng)達(dá)到上限,請(qǐng)調(diào)高上限或停止發(fā)放。 |
403 | USER_ACCOUNT_ABNORMAL | 用戶非法 | 該用戶賬號(hào)異常,無(wú)法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請(qǐng)檢查批次ID是否正確 |
429 | FREQUENCY_LIMITED | 請(qǐng)求過(guò)于頻繁 | 稍后重試 |