在用戶滿足優(yōu)惠門檻后,商戶可通過(guò)該接口核銷用戶微信卡包中具體某一張商家券。
核銷頻率:500QPS
# 接口說(shuō)明
支持商戶:
【普通商戶】
請(qǐng)求方式:
【POST】/v3/marketing/busifavor/coupons/use
請(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
- Content-Type 必填 string請(qǐng)?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- coupon_code 必填 string【券code】 券的唯一標(biāo)識(shí)
- stock_id 選填 string【批次號(hào)】 微信為每個(gè)商家券批次分配的唯一ID,當(dāng)你在創(chuàng)建商家券接口中的coupon_code_mode參數(shù)傳值為MERCHANT_API或者M(jìn)ERCHANT_UPLOAD時(shí),則核銷接口中該字段必傳,否則該字段可不傳
- appid 必填 string【公眾賬號(hào)ID】 支持傳入與當(dāng)前調(diào)用接口商戶號(hào)有綁定關(guān)系的AppID。支持小程序AppID與公眾號(hào)AppID。核銷接口返回的OpenID會(huì)在該傳入AppID下進(jìn)行計(jì)算獲得。
校驗(yàn)規(guī)則:傳入的AppID得是與調(diào)用方商戶號(hào)(即請(qǐng)求頭里面的商戶號(hào))有綁定關(guān)系的AppID或傳入的AppID得是歸屬商戶號(hào)有綁定關(guān)系的AppID - use_time 必填 string【請(qǐng)求核銷時(shí)間】 商戶請(qǐ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秒。 - use_request_no 必填 string(128)【核銷請(qǐng)求單據(jù)號(hào)】 每次核銷請(qǐng)求的唯一標(biāo)識(shí),商戶需保證唯一
- openid 選填 string【用戶標(biāo)識(shí)】 用戶的唯一標(biāo)識(shí),做安全校驗(yàn)使用,非必填。
校驗(yàn)規(guī)則:傳入的OpenID得是調(diào)用方商戶號(hào)(即請(qǐng)求頭里面的商戶號(hào))有綁定關(guān)系的AppID獲取的OpenID或傳入的OpenID得是歸屬商戶號(hào)有綁定關(guān)系的AppID獲取的OpenID。獲取OpenID文檔
Body 包體參數(shù)
請(qǐng)求示例
POST
# 應(yīng)答參數(shù)
- stock_id 必填 string【批次號(hào)】 批次ID
- openid 必填 string【用戶標(biāo)識(shí)】 用戶在該公眾號(hào)內(nèi)的唯一身份標(biāo)識(shí)。
- wechatpay_use_time 必填 string【系統(tǒng)核銷券成功的時(shí)間】 系統(tǒ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秒。
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 | AppID與請(qǐng)求方商戶無(wú)關(guān)聯(lián)關(guān)系 | AppID與請(qǐng)求方商戶不匹配,請(qǐng)確認(rèn)AppID與請(qǐng)求方商戶是否有關(guān)聯(lián)關(guān)系 |
400 | INVALID_REQUEST | 發(fā)券模式不合法 | 請(qǐng)更換支持預(yù)上傳code的批次后重試 |
400 | INVALID_REQUEST | 上傳的自定義code已達(dá)上限 | 請(qǐng)更換一個(gè)新的批次后重試 |
400 | MCH_NOT_EXISTS | 商戶號(hào)不存在 | 請(qǐng)確認(rèn)傳入的商戶號(hào)是否正確 |
400 | RESOURCE_ALREADY_EXISTS | 批次已存在 | 查看out_request_no字段是否重復(fù)使用 |
400 | RESOURCE_ALREADY_EXISTS | 券已被其他訂單核銷 | 請(qǐng)通過(guò)查詢?nèi)疉PI確認(rèn)券是否已被其他訂單核銷 |
400 | SYSTEM_ERROR | 系統(tǒng)錯(cuò)誤 | 請(qǐng)使用相同參數(shù)稍后重新調(diào)用 |
403 | NOAUTH | 無(wú)權(quán)限 | 查看具體錯(cuò)誤信息,確認(rèn)是否有權(quán)限 |
403 | RULELIMIT | 券不在有效期 | 請(qǐng)確認(rèn)券是否能在當(dāng)前時(shí)間核銷 |
404 | RESOURCE_NOT_EXISTS | 查詢的資源不存在 | 請(qǐng)檢查查詢資源的對(duì)應(yīng)ID是否填寫正確 |
404 | USER_NOT_EXISTS | OpenID不正確 | 請(qǐng)確認(rèn)傳入的OpenID是否正確 |
429 | FREQUENCY_LIMITED | 頻率限制 | 調(diào)用太頻繁,請(qǐng)降低調(diào)用接口頻率 |
500 | SYSTEM_ERROR | 系統(tǒng)失敗 | 多為網(wǎng)絡(luò)超時(shí)引起,重試 |