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