最新更新時間：2020.08.06 版本說明
當(dāng)交易發(fā)生之后一段時間內(nèi)，由于買家或者賣家的原因需要退款時，賣家可以通過退款接口將支付款退還給買家，微信支付將在收到退款請求并且驗證成功之后，按照退款規(guī)則將支付款按原路退到買家賬號上。
? 交易時間超過一年的訂單無法提交退款。
? 微信支付退款支持單筆交易分多次退款，多次退款需要提交原支付訂單的商戶訂單號和設(shè)置不同的退款單號。申請退款總金額不能超過訂單金額。 一筆退款失敗后重新提交，請不要更換退款單號，請使用原商戶退款單號。
? 請求頻率限制：150qps，即每秒鐘正常的申請退款請求次數(shù)不超過150次，錯誤或無效請求頻率限制：6qps，即每秒鐘異常或錯誤的退款申請請求不超過6次。
? 每個支付訂單的部分退款次數(shù)不能超過50次。
? 申請退款接口的返回僅代表業(yè)務(wù)的受理情況，具體退款是否成功，需要通過退款查詢接口獲取結(jié)果。
適用對象：電商平臺
請求URL：https://api.mch.weixin.qq.com/v3/ecommerce/refunds/apply
請求方式：POST
接口規(guī)則：http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path指該參數(shù)為路徑參數(shù)
query指該參數(shù)需在請求URL傳參
body指該參數(shù)需在請求JSON傳參
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 二級商戶號 | sub_mchid | string[1,32] | 是 | body 微信支付分配二級商戶的商戶號。 示例值：?1900000109 |
| 電商平臺APPID | sp_appid | string[1,32] | 是 | body 電商平臺在微信公眾平臺申請服務(wù)號對應(yīng)的APPID，申請商戶功能的時候微信支付會配置綁定關(guān)系。 示例值：wx8888888888888888 |
| 二級商戶APPID | sub_appid | string[1,32] | 否 | body 二級商戶在微信申請公眾號成功后分配的賬號ID，需要電商平臺側(cè)配置綁定關(guān)系才能傳參（即二級商戶已綁定微信公眾號時傳入）。
示例值：wx8888888888888888 |
| 微信訂單號 | transaction_id | string[1,32] | 二選一 | body 原支付交易對應(yīng)的微信訂單號。 示例值：1217752501201407033233368018 |
| 商戶訂單號 | out_trade_no | string[1,32] | body 原支付交易對應(yīng)的商戶訂單號。 示例值：1217752501201407033233368018 |
|
| 商戶退款單號 | out_refund_no | string[1,64] | 是 | body 商戶系統(tǒng)內(nèi)部的退款單號，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-|*@，同一退款單號多次請求只退一筆。 示例值：1217752501201407033233368018 |
| 退款原因 | reason | string[1,80] | 否 | body 若商戶傳入，會在下發(fā)給用戶的退款消息中體現(xiàn)退款原因。 注意：若訂單退款金額≤1元，且屬于部分退款，則不會在退款消息中體現(xiàn)退款原因 示例值：商品已售完 |
| +訂單金額 | amount | object | 是 | body 訂單金額信息 |
| 退款結(jié)果回調(diào)url | notify_url | string[1,256] | 否 | body 異步接收微信支付退款結(jié)果通知的回調(diào)地址，通知url必須為外網(wǎng)可訪問的url，不能攜帶參數(shù)。 如果參數(shù)中傳了notify_url，則商戶平臺上配置的回調(diào)地址將不會生效，優(yōu)先回調(diào)當(dāng)前傳的地址。 示例值：https://weixin.qq.com |
{
"sub_mchid": "1900000109",
"sp_appid": "wx8888888888888888",
"sub_appid": "wx8888888888888888",
"transaction_id": "1217752501201407033233368018",
"out_trade_no": "1217752501201407033233368018",
"out_refund_no": "1217752501201407033233368018",
"reason": "商品已售完",
"amount": {
"refund": 888,
"total": 888,
"currency": "CNY"
},
"notify_url": "https://weixin.qq.com"
}
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 微信退款單號 | refund_id | string[1,32] | 是 | 微信支付退款訂單號。 示例值：1217752501201407033233368018 |
| 商戶退款單號 | out_refund_no | string[1,64] | 是 | 商戶系統(tǒng)內(nèi)部的退款單號，商戶系統(tǒng)內(nèi)部唯一，同一退款單號多次請求只退一筆。 示例值：1217752501201407033233368018 |
| 退款創(chuàng)建時間 | create_time | string[1,64] | 是 | 退款受理時間，遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss表示時分秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領(lǐng)先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35+08:00表示，北京時間2015年5月20日13點29分35秒。 示例值：2018-06-08T10:34:56+08:00 |
| +訂單金額 | amount | object | 是 | 訂單金額信息 |
| +優(yōu)惠退款詳情 | promotion_detail | array | 否 | 優(yōu)惠退款功能信息，discount_refund>0時，返回該字段 示例值：見示例 |
{
"refund_id": "1217752501201407033233368018",
"out_refund_no": "1217752501201407033233368018",
"create_time": "2018-06-08T10:34:56+08:00",
"amount": {
"refund": 888,
"payer_refund": 888,
"discount_refund": 888,
"currency": "CNY"
},
"promotion_detail": [
{
"promotion_id": "109518",
"scope": "SINGLE",
"type": "DISCOUNT",
"amount": 5,
"refund_amount": 100
},
{
"promotion_id": "109519",
"scope": "SINGLE",
"type": "DISCOUNT",
"amount": 5,
"refund_amount": 100
}
],
}
| 狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 500 | SYSTEM_ERROR | 接口返回錯誤 | 請不要更換商戶退款單號，請使用相同參數(shù)再次調(diào)用API。 |
| 404 | RESOURCE_NOT_EXISTS | 訂單不存在 | 請檢查訂單號是否正確且是否已支付，未支付的訂單不能發(fā)起退款 |
| 400 | PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)錯誤，請重新檢查再調(diào)用退款申請 |
| 429 | FREQUENCY_LIMITED | 頻率限制 | 該筆退款未受理，請降低頻率后重試 |
| 403 | NOT_ENOUGH | 余額不足 | 此狀態(tài)代表退款申請失敗，商戶可根據(jù)具體的錯誤提示做相應(yīng)的處理。 |
| 403 | USER_ACCOUNT_ABNORMAL | 退款請求失敗 | 此狀態(tài)代表退款申請失敗，商戶可自行處理退款。 |
| 403 | NO_AUTH | 沒有退款權(quán)限 | 此狀態(tài)代表退款申請失敗，請檢查是否有退這筆訂單的權(quán)限 |
| 401 | SIGN_ERROR | 簽名錯誤 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| 400 | INVALID_REQUEST | 請求參數(shù)符合參數(shù)格式，但不符合業(yè)務(wù)規(guī)則 | 此狀態(tài)代表退款申請失敗，商戶可根據(jù)具體的錯誤提示做相應(yīng)的處理。 |
| 400 | MCH_NOT_EXISTS | 商戶號不存在 | 請檢查商戶號是否正確 |
| 403 | REQUEST_BLOCKED | 請求受阻 | 此狀態(tài)代表退款申請失敗，商戶可根據(jù)具體的錯誤提示做相應(yīng)的處理。 |