微信支付分訂單創(chuàng)建之后,由于某些原因?qū)е掠唵尾荒苷VЦ稌r,可使用此接口取消訂單。
注意:
- DOING狀態(tài)包含了訂單用戶確認(rèn)、已完結(jié)-待支付(USER_PAYING)的狀態(tài),因此這種狀態(tài)下訂單也是可以被取消的,請確認(rèn)當(dāng)前操作是否正確,防止誤操作將完結(jié)后需要支付分收款的單據(jù)取消。
- 訂單為以下狀態(tài)時可以取消訂單:CREATED(已創(chuàng)單)、DOING(進(jìn)行中)(包括商戶完結(jié)支付分訂單后,且支付分訂單收款狀態(tài)為待支付USER_PAYING)
- 特別注意:待支付(USER_PAYING)狀態(tài)下,當(dāng)用戶正在嘗試通過收銀臺主動支付訂單金額時,取消支付分訂單API無法調(diào)用成功,可等待3min后重試
# 接口說明
支持商戶:
【普通服務(wù)商】
請求方式:
【POST】/v3/payscore/partner/serviceorder/{out_order_no}/cancel
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點(diǎn) ,指引點(diǎn)擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請設(shè)置為
application/json
- Content-Type 必填 string請設(shè)置為
application/json
Header HTTP頭參數(shù)
- out_order_no 必填 string(32)【商戶訂單號】 商戶系統(tǒng)內(nèi)部服務(wù)訂單號(不是交易單號),要求32個字符內(nèi),只能是數(shù)字、大小寫字母_-|* 且在同一個商戶號下唯一。
Path 路徑參數(shù)
- service_id 選填 string(32)【服務(wù)ID】 該服務(wù)ID有本接口對應(yīng)產(chǎn)品的權(quán)限
- sub_mchid 必填 string(32)【子商戶商戶號】 子商戶商戶號,由微信支付生成并下發(fā)
- reason 必填 string(50)【撤銷原因】 支持50個字符,按照字符計算,超過長度報錯處理
Body 包體參數(shù)
請求示例
POST
# 應(yīng)答參數(shù)
無應(yīng)答包體
應(yīng)答示例
204 No Content
# 錯誤碼
# 公共錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯誤 | 請根據(jù)錯誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗(yàn)證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | INVALID_ORDER_STATE | 單據(jù)狀態(tài)錯誤 | 確認(rèn)操作是否符合流程 |
400 | INVALID_REQUEST | 請求參數(shù)符合參數(shù)格式,但不符合業(yè)務(wù)規(guī)則 | 請確認(rèn)相同單號是否使用了不同的參數(shù) |
400 | ORDER_CANCELED | 單據(jù)已取消 | 當(dāng)前狀態(tài)無需操作 |
400 | ORDER_DONE | 訂單已完成 | 當(dāng)前狀態(tài)無需操作 |
403 | NO_AUTH | 商戶信息不合法 | 登錄商戶平臺核對,傳入正確信息 |
404 | ORDER_NOT_ EXIST | 訂單不存在 | 確認(rèn)入?yún)ⅲ瑐魅胝_單據(jù) |
429 | FREQUENCY_LIMITED | 頻率超限 | 請求量不要超過接口調(diào)用頻率限制 |
500 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 5開頭的狀態(tài)碼都為系統(tǒng)問題,請使用相同參數(shù)稍后重新調(diào)用 |