用于設(shè)置接收營銷事件通知的URL,可接收營銷相關(guān)的事件通知:核銷通知
注意:該接口只能創(chuàng)建商戶號(hào)進(jìn)行設(shè)置
接口頻率:不區(qū)分來源 1000/min 單ip 5/min
冪等規(guī)則:接口支持冪等重入
接口耗時(shí):100ms
# 接口說明
支持商戶:
【普通服務(wù)商】【從業(yè)機(jī)構(gòu)(銀行)】【從業(yè)機(jī)構(gòu)(支付機(jī)構(gòu))】【渠道商】【清算機(jī)構(gòu)】
請(qǐng)求方式:
【POST】/v3/marketing/favor/callbacks
請(qǐng)求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點(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
- Content-Type 必填 string請(qǐng)?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- mchid 必填 string(20)【商戶號(hào)】 微信支付商戶號(hào)
校驗(yàn)規(guī)則:該商戶號(hào)必須為創(chuàng)建商戶號(hào)進(jìn)行配置 - notify_url 必填 string(256)【通知url地址】 支付通知商戶url地址。
校驗(yàn)規(guī)則:
1、notify_url必須為https
2、地址要是一個(gè)可訪問的地址
3、不能攜帶參數(shù)。示例: “http://www.tg885.com/wxpay/pay.action” - switch 選填 boolean【回調(diào)開關(guān)】 如果商戶不需要再接收營銷事件通知,可通過該開關(guān)關(guān)閉。
枚舉值:
true:開啟推送
false:停止推送
校驗(yàn)規(guī)則:
1、該參數(shù)設(shè)置為false暫不支持使用
2、如果想關(guān)閉通知請(qǐng)?jiān)谏虘羝脚_(tái)關(guān)閉券的回調(diào)通知
Body 包體參數(shù)
請(qǐng)求示例
POST
# 應(yīng)答參數(shù)
- update_time 必填 string【修改時(shí)間】 修改時(shí)間,遵循rfc3339
標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,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秒。 - notify_url 必填 string【通知地址】 通知地址
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)證不通過 | 請(qǐng)參閱 簽名常見問題 |
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í)顚懟卣{(diào)URL |
400 | PARAM_ERROR | 回調(diào)商戶不能為空 | 請(qǐng)?zhí)顚懟卣{(diào)商戶 |
400 | PARAM_ERROR | 券ID必填 | 請(qǐng)?zhí)顚懭疘D |
400 | PARAM_ERROR | AppID必填 | 請(qǐng)輸入AppID |
400 | PARAM_ERROR | OpenID必填 | 請(qǐng)輸入OpenID |
400 | PARAM_ERROR | 頁大小超過閾值 | 請(qǐng)不要超過最大的頁大小 |
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)用商戶無權(quán)限 | 請(qǐng)開通產(chǎn)品權(quán)限后再調(diào)用該接口 |
403 | REQUEST_BLOCKED | 商戶無權(quán)發(fā)券 | 調(diào)用接口的商戶號(hào)無權(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)異常,無法領(lǐng)券。商家可聯(lián)系微信支付或讓用戶聯(lián)系微信支付客服處理。 |
404 | RESOURCE_NOT_EXISTS | 批次不存在 | 請(qǐng)檢查批次ID是否正確 |
429 | FREQUENCY_LIMITED | 請(qǐng)求過于頻繁 | 稍后重試 |