當(dāng)支付分訂單狀態(tài)在已創(chuàng)建(state:CREATE)、用戶已確認(rèn)訂單(collection.state: USER_CONFIRM)和待支付狀態(tài)(collection.state: USER_PAYING)情況下,商戶可以取消服務(wù)訂單,調(diào)用接口后會同步返回取消結(jié)果,可參考支付分訂單狀態(tài)流轉(zhuǎn)圖做業(yè)務(wù)邏輯處理。
注意:
1.若因網(wǎng)絡(luò)原因未獲取到接口返回內(nèi)容,商戶可使用相同參數(shù)重試,該接口支持原參重入。
2.待支付狀態(tài)的訂單,若用戶正在通過支付分訂單頁拉起收銀臺主動支付或者支付分正在進(jìn)行自動扣款時,調(diào)用取消支付分訂單API可能會出現(xiàn)"單據(jù)正在扣款中,請稍后再試"的報錯,可等待3min后重試。
# 接口說明
支持商戶:
【普通商戶】
請求方式:
【POST】/v3/payscore/serviceorder/{out_order_no}/cancel
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(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)【商戶服務(wù)訂單號】 商戶系統(tǒng)內(nèi)部服務(wù)訂單號,商戶在創(chuàng)建支付分接口中填入的out_order_no參數(shù)。
Path 路徑參數(shù)
- appid 必填 string(32)【公眾賬號ID】 是微信開放平臺和微信公眾平臺為開發(fā)者的應(yīng)用程序(APP、小程序、公眾號)提供的一個唯一標(biāo)識。 開發(fā)者需要先在微信開放平臺或微信公眾平臺中申請ID,然后在商戶平臺中綁定,詳見直連商戶與AppID賬號關(guān)聯(lián)管理
。完結(jié)訂單和取消訂單需要和創(chuàng)單傳入的appid保持一致。 - service_id 必填 string(32)【服務(wù)ID】 商戶支付分服務(wù)的唯一標(biāo)識,由32位數(shù)字組成。支付分產(chǎn)品權(quán)限審核通過后,微信支付運營會向商戶提供該ID。
- reason 必填 string(50)【撤銷原因】 支付分取消訂單原因,長度不能超過50個字符,用戶微信收到的取消訂單消息通知會展示該字段。
Body 包體參數(shù)
請求示例
POST
# 應(yīng)答參數(shù)
- appid 必填 string(32)【公眾賬號ID】 是微信開放平臺和微信公眾平臺為開發(fā)者的應(yīng)用程序(APP、小程序、公眾號)提供的一個唯一標(biāo)識。 開發(fā)者需要先在微信開放平臺或微信公眾平臺中申請ID,然后在商戶平臺中綁定,詳見直連商戶與AppID賬號關(guān)聯(lián)管理
。完結(jié)訂單和取消訂單需要和創(chuàng)單傳入的appid保持一致。 - mchid 必填 string(32)【商戶號】 調(diào)用支付分創(chuàng)單接口提交的商戶號,商戶號需開通支付分產(chǎn)品權(quán)限,且與appid有綁定關(guān)系,詳見直連商戶與AppID賬號關(guān)聯(lián)管理
。 - out_order_no 必填 string(32)【商戶訂單號】 商戶系統(tǒng)內(nèi)部服務(wù)訂單號,商戶在創(chuàng)建支付分接口中填入的out_order_no參數(shù)。
- service_id 必填 string(32)【服務(wù)ID】 商戶支付分服務(wù)的唯一標(biāo)識,由32位數(shù)字組成。支付分產(chǎn)品權(quán)限審核通過后,微信支付運營會向商戶提供該ID。
- order_id 必填 string(128)【微信支付服務(wù)訂單號】 支付分訂單在微信側(cè)的唯一標(biāo)識,31位數(shù)字,開頭由1000000000+年月日組成。
200OK
應(yīng)答示例
200 OK
# 錯誤碼
# 公共錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯誤 | 請根據(jù)錯誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗證不通過 | 請參閱 簽名常見問題 |
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)用 |