最新更新時間:2020.1.08 版本說明
當(dāng)交易發(fā)生之后一段時間內(nèi),由于買家或者賣家的原因需要退款時,賣家可以通過退款接口將支付款退還給買家,微信支付將在收到退款請求并且驗證成功之后,按照退款規(guī)則將支付款按原路退到買家?guī)ぬ柹稀?/p>
● 交易時間超過一年的訂單無法提交退款。
● 微信支付退款支持單筆交易分多次退款,多次退款需要提交原支付訂單的商戶訂單號和設(shè)置不同的退款單號。申請退款總金額不能超過訂單金額。 一筆退款失敗后重新提交,請不要更換退款單號,請使用原商戶退款單號。
● 每個支付訂單的部分退款次數(shù)不能超過50次。
● 錯誤或無效請求頻率限制:6qps,即每秒鐘異常或錯誤的退款申請請求不超過6次。
適用對象:直連模式機(jī)構(gòu)模式
請求URL: https://api.mch.weixin.qq.com/hk/v3/refunds
請求方式: POST
接口規(guī)則:https://wechatpay-api.gitbook.io/wechatpay-api-v3
頻率限制:150qps
path 指該參數(shù)需在請求URL傳參
query 指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
商戶號 | mchid | 是 | string(32) | query 微信支付分配的商戶號 注意:僅適用于直連模式 示例值:1900000109 |
APPID | appid | 是 | string(32) | query 商戶在微信開放平臺申請移動應(yīng)用對應(yīng)的APPID 注意:僅適用于直連模式 示例值:wx8888888888888888 |
機(jī)構(gòu)商戶號 | sp_mchid | 是 | string(32) | query 微信支付分配給機(jī)構(gòu)的商戶號 注意:僅適用于機(jī)構(gòu)模式 示例值:1900000100 |
子商戶號 | sub_mchid | 是 | string(32) | query 微信支付分配子商戶的商戶號 注意:僅適用于機(jī)構(gòu)模式 示例值:1900000109 |
機(jī)構(gòu)APPID | sp_appid | 是 | string(32) | query 商戶在微信公眾平臺申請服務(wù)號對應(yīng)的APPID 注意:僅適用于機(jī)構(gòu)模式 示例值:wx8888888888888888 |
子商戶APPID | sub_appid | 否 | string(32) | query 子商戶在微信開放平臺申請移動應(yīng)用對應(yīng)的APPID 注意:僅適用于機(jī)構(gòu)模式 示例值:wx8888888888888888 |
微信訂單號 | transaction_id | 二選一 | string(32) | query 原支付交易對應(yīng)的微信訂單號 示例值:1217752501201407033233368018 |
商戶訂單號 | out_trade_no | string(32) | query 原支付交易對應(yīng)的訂單號 示例值:1217752501201407033233368018 |
|
商戶退款單號 | out_refund_no | 是 | string(64) | query 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號多次請求只退一筆。 示例值:1217752501201407033233368018 |
退款原因 | reason | 否 | string(80) | query 若商戶傳入,會在下發(fā)給用戶的退款消息中體現(xiàn)退款原因 注意:若訂單退款金額≤1元,且屬于部分退款,則不會在退款消息中體現(xiàn)退款原因 示例值:商品已售完 |
+ 訂單金額 | amount | 是 | object | query 訂單金額信息,詳細(xì)說明見下文 |
退款通知地址 | notify_url | 否 | string(256) | query異步接收微信退款狀態(tài)變更的回調(diào)地址,通知url必須為外網(wǎng)可訪問的url,不能攜帶參數(shù)。請使用https協(xié)議鏈接 示例值:https://www.weixin.qq.com/wxpay/pay.php |
{
" appid": "wx2421b1c4370ec43b",
"sub_appid": "",
"sp_mchid": "10000100",
"sub_mchid": "20000100",
"transaction_id": "1008450740201411110005820873",
"out_trade_no": "20150806125346",
"out_refund_no": "R20150806125346",
"amount" : {
"refund": 50,
"total":100,
"currency":"HKD"
},
"reason": "商品已售完",
"source": "REFUND_SOURCE_UNSETTLED_FUNDS"
}
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
微信支付退款訂單號 | id | string(32) | 是 | 微信支付退款訂單號 示例值:1217752501201407033233368018 |
商戶退款單號 | out_refund_no | string(64) | 是 | 返回的退款訂單號。 示例值:1217752501201407033233368018 |
退款創(chuàng)建時間 | create_time? | string(64) | 是 | 退款受理時間, 示例值:2018-06-08T10:34:56+08:00 |
+ 退款金額 | amount | object | 是 | 退款金額信息,詳細(xì)說明見下文 |
+ 優(yōu)惠退款詳情 | detail | object | 否 | 優(yōu)惠退款詳情信息,詳細(xì)說明見下文 |
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | code | string(32) | 是 | 錯誤碼,枚舉值見錯誤碼列表 示例值:INVALID_REQUEST |
返回信息 | message | string(256) | 是 | 返回信息,如非空,為錯誤原因 示例值:參數(shù)格式校驗錯誤 |
+ 詳細(xì)的錯誤描述 | detail | object | 否 | 當(dāng)code為PARAM_ERROR時返回,詳細(xì)說明見下 |
{
{
"id": "2008450740201411110000174436",
"out_refund_no": "R20150806125346",
"create_time": "20141111170042",
"amount": {
"refund": 50,
"currency": "CNY",
"payer_refund": 49,
"payer_currency": "HKD",
"exchange_rate" : {
"type": "SETTLEMENT_RATE",
"rate": 8000000
}
},
"detail": [
{
"promotion_id":"109519",
"scope":"GLOBAL",
"type":"COUPON",
"amount": 1,
"refund_amount": 1,
"currency":"HKD"
}
]
}
錯誤碼 | 描述 | 解決方案 |
---|---|---|
SYSTEMERROR | 接口返回錯誤 | 請不要更換商戶退款單號,請使用相同參數(shù)再次調(diào)用API。否則可能造成資金損失 |
BIZERR_NEED_RETRY | 退款業(yè)務(wù)流程錯誤,需要商戶觸發(fā)重試來解決 | 請不要更換商戶退款單號,請使用相同參數(shù)再次調(diào)用API。否則可能造成資金損失 |
TRADE_OVERDUE | 訂單已經(jīng)超過退款期限 | 請選擇其他方式自行退款 |
ERROR | 業(yè)務(wù)錯誤 | 該錯誤都會返回具體的錯誤原因,請根據(jù)實際返回做相應(yīng)處理。 |
USER_ACCOUNT_ABNORMAL | 退款請求失敗 | 此狀態(tài)代表退款申請失敗,商戶可自行處理退款。 |
INVALID_REQ_TOO_MUch | 無效請求過多 | 請檢查業(yè)務(wù)是否正常,確認(rèn)業(yè)務(wù)正常后請在1分鐘后再來重試 |
NOTENOUGH | 余額不足 | 此狀態(tài)代表退款申請失敗,商戶可根據(jù)具體的錯誤提示做相應(yīng)的處理。 |
INVALID_TRANSACTIONID | 無效transaction_id | 請求參數(shù)錯誤,檢查原交易號是否存在或發(fā)起支付交易接口返回失敗 |
PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)錯誤,請重新檢查再調(diào)用退款申請 |
APPID_NOT_EXIST | APPID不存在 | 請檢查APPID是否正確 |
MchID_NOT_EXIST | MchID不存在 | 請檢查MchID是否正確 |
REQUIRE_POST_METHOD | 請使用post方法 | 請檢查請求參數(shù)是否通過post方法提交 |
SIGNERROR | 簽名錯誤 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
FREQUENCY_LIMITED | 頻率限制 | 該筆退款未受理,請降低頻率后重試,該筆退款未受理,請降低頻率后原單重試,請勿更換單號 |
ORDERNOTEXIST | 訂單號不存在 | 請檢查你的訂單號是否正確且是否已支付,未支付的訂單不能發(fā)起退款 |
INVALID_REQUEST | 請求參數(shù)符合參數(shù)格式,但不符合業(yè)務(wù)規(guī)則 | 此狀態(tài)代表退款申請失敗,商戶可根據(jù)具體的錯誤提示做相應(yīng)的處理。 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證