最新更新時(shí)間：2020.10.10 版本說(shuō)明
當(dāng)交易發(fā)生之后一段時(shí)間內(nèi)，由于買家或者賣家的原因需要退款時(shí)，賣家可以通過(guò)退款接口將支付款退還給買家，微信支付將在收到退款請(qǐng)求并且驗(yàn)證成功之后，按照退款規(guī)則將支付款按原路退到買家賬號(hào)上。
● 交易時(shí)間超過(guò)一年的訂單無(wú)法提交退款；
● 微信支付退款支持單筆交易分多次退款，多次退款需要提交原支付訂單的商戶訂單號(hào)和設(shè)置不同的退款單號(hào)。申請(qǐng)退款總金額不能超過(guò)訂單金額。 一筆退款失敗后重新提交，請(qǐng)不要更換退款單號(hào)，請(qǐng)使用原商戶退款單號(hào)；
● 請(qǐng)求頻率限制：150qps，即每秒鐘正常的申請(qǐng)退款請(qǐng)求次數(shù)不超過(guò)150次；
錯(cuò)誤或無(wú)效請(qǐng)求頻率限制：6qps，即每秒鐘異常或錯(cuò)誤的退款申請(qǐng)請(qǐng)求不超過(guò)6次
● 每個(gè)支付訂單的部分退款次數(shù)不能超過(guò)50次；
● 如果同一個(gè)用戶有多筆退款，建議分不同批次進(jìn)行退款，避免并發(fā)退款導(dǎo)致退款失敗。
● 申請(qǐng)退款接口的返回僅代表業(yè)務(wù)的受理情況，具體退款是否成功，需要通過(guò)退款查詢接口獲取結(jié)果。
服務(wù)商模式下，退款接口需要單獨(dú)申請(qǐng)權(quán)限，詳見(jiàn)：特約商戶退款權(quán)限授權(quán)及解除操作方法
適用對(duì)象：直連商戶 服務(wù)商
請(qǐng)求URL： https://api.mch.weixin.qq.com/secapi/pay/refund
冗災(zāi)備用URL：https://api2.mch.weixin.qq.com/secapi/pay/refund(備用域名)見(jiàn)跨城冗災(zāi)方案
請(qǐng)求方式： POST
數(shù)據(jù)格式： XML
是否需要證書： 需要雙向證書。 詳見(jiàn)證書使用
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 應(yīng)用ID | appid | string[1,32] | 是 | 微信分配的應(yīng)用ID 示例值：wx8888888888888888 |
| 商戶號(hào) | mch_id | string[1,32] | 是 | 微信支付分配的商戶號(hào) 示例值：1900000109 |
| 子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應(yīng)用ID，如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意：僅適用于服務(wù)商模式 示例值：wx8888888888888888 |
| 子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號(hào) 注意：僅適用于服務(wù)商模式 示例值：1900000109 |
| 隨機(jī)字符串 | nonce_str | string[1,32] | 是 | 隨機(jī)字符串，不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
| 簽名 | sign | string[1,64] | 是 | 簽名，詳見(jiàn)簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 簽名類型 | sign_type | string[1,32] | 否 | 簽名類型，目前支持HMAC-SHA256和MD5，默認(rèn)為MD5 示例值：HMAC-SHA256 |
| 微信支付訂單號(hào) | transaction_id | string[1,32] | 二選一 | 微信的訂單號(hào)，優(yōu)先使用 示例值：1217752501201407033233368018 |
| 商戶訂單號(hào) | out_trade_no | string[1,32] | 商戶系統(tǒng)內(nèi)部訂單號(hào)，要求32個(gè)字符內(nèi)，只能是數(shù)字、大小寫字母_-|*@ ，且在同一個(gè)商戶號(hào)下唯一。 示例值：1217752501201407033233368018 |
|
| 商戶退款單號(hào) | out_refund_no | string[1,64] | 是 | 商戶系統(tǒng)內(nèi)部的退款單號(hào)，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-|*@ ，同一退款單號(hào)多次請(qǐng)求只退一筆。 示例值：1217752501201407033233368018 |
| 訂單金額 | total_fee | int | 是 | 訂單總金額，單位為分，只能為整數(shù)，詳見(jiàn)交易金額 示例值：100 |
| 申請(qǐng)退款金額 | refund_fee | int | 是 | 退款總金額，單位為分，只能為整數(shù)，可部分退款。詳見(jiàn)交易金額 示例值：100 |
| 退款貨幣種類 | refund_fee_type | string[1,8] | 否 | 退款貨幣類型，需與支付一致，或者不填。符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼，默認(rèn)人民幣：CNY，其他值列表詳見(jiàn)貨幣類型 示例值：CNY |
| 退款原因 | refund_desc | string[1,80] | 否 | 若商戶傳入，會(huì)在下發(fā)給用戶的退款消息中體現(xiàn)退款原因 注意：若訂單退款金額≤1元，且屬于部分退款，則不會(huì)在退款消息中體現(xiàn)退款原因 示例值：商品已售完 |
| 退款資金來(lái)源 | refund_account | string[1,30] | 否 | 僅針對(duì)老資金流商戶使用 REFUND_SOURCE_UNSETTLED_FUNDS：未結(jié)算資金退款（默認(rèn)使用未結(jié)算資金退款） REFUND_SOURCE_RECHARGE_FUNDS：可用余額退款 示例值：REFUND_SOURCE_RECHARGE_FUNDS |
| 退款結(jié)果通知url | notify_url | string[1,256] | 否 | 異步接收微信支付退款結(jié)果通知的回調(diào)地址，通知URL必須為外網(wǎng)可訪問(wèn)的url，不允許帶參數(shù) 如果參數(shù)中傳了notify_url，則商戶平臺(tái)上配置的回調(diào)地址將不會(huì)生效。 示例值：https://weixin.qq.com/notify/ |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
<sub_mch_id>1415701182</sub_mch_id>
<out_refund_no>1415701182</out_refund_no>
<out_trade_no>1415757673</out_trade_no>
<refund_fee>1</refund_fee>
<total_fee>1</total_fee>
<transaction_id>4006252001201705123297353072</transaction_id>
<sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標(biāo)識(shí)，非交易標(biāo)識(shí)，交易是否成功需要查看result_code來(lái)判斷 示例值：SUCCESS |
| 返回信息 | return_msg | string[1,128] | 否 | 返回信息，如非空，為錯(cuò)誤原因 簽名失敗 參數(shù)格式校驗(yàn)錯(cuò)誤 示例值：簽名失敗 |
返回狀態(tài)碼(return_code)為SUCCESS的時(shí)候,包含以下字段
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 業(yè)務(wù)結(jié)果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值：SUCCESS |
| 錯(cuò)誤代碼 | err_code | string[1,32] | 否 | 詳細(xì)參見(jiàn)錯(cuò)誤列表 示例值：SYSTEMERROR |
| 錯(cuò)誤代碼描述 | err_code_des | string[1,128] | 否 | 結(jié)果信息描述 示例值：系統(tǒng)錯(cuò)誤 |
| 應(yīng)用ID | appid | string[1,32] | 是 | 微信分配的應(yīng)用ID 示例值：wx8888888888888888 |
| 商戶號(hào) | mch_id | string[1,32] | 是 | 微信支付分配的商戶號(hào) 示例值：1900000109 |
| 子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應(yīng)用ID，如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意：僅適用于服務(wù)商模式 示例值：wx8888888888888888 |
| 子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號(hào) 注意：僅適用于服務(wù)商模式 示例值：1900000109 |
| 隨機(jī)字符串 | nonce_str | string[1,32] | 是 | 隨機(jī)字符串，不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
| 簽名 | sign | string[1,64] | 是 | 簽名，詳見(jiàn)簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 微信支付訂單號(hào) | transaction_id | string[1,32] | 是 | 微信支付訂單號(hào) 示例值：1217752501201407033233368018 |
| 商戶訂單號(hào) | out_trade_no | string[1,32] | 是 | 商戶系統(tǒng)內(nèi)部訂單號(hào)，要求32個(gè)字符內(nèi)，只能是數(shù)字、大小寫字母_-|*@ ，且在同一個(gè)商戶號(hào)下唯一。 示例值：1217752501201407033233368018 |
| 商戶退款單號(hào) | out_refund_no | string[1,64] | 是 | 商戶系統(tǒng)內(nèi)部的退款單號(hào)，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-|*@ ，同一退款單號(hào)多次請(qǐng)求只退一筆。 示例值：1217752501201407033233368018 |
| 微信退款單號(hào) | refund_id | string[1,32] | 是 | 微信退款單號(hào) 示例值：1217752501201407033233368018 |
| 申請(qǐng)退款金額 | refund_fee | int | 是 | 退款總金額,單位為分,可以做部分退款 示例值：100 |
| 退款金額 | settlement_refund_fee | int | 否 | 去掉非充值代金券退款金額后的退款金額，退款金額=申請(qǐng)退款金額-非充值代金券退款金額，退款金額<=申請(qǐng)退款金額 示例值：100 |
| 訂單金額 | total_fee | int | 是 | 訂單總金額，單位為分，只能為整數(shù)，詳見(jiàn)交易金額 示例值：100 |
| 應(yīng)結(jié)訂單金額 | settlement_total_fee | int | 否 | 應(yīng)結(jié)訂單金額=訂單金額-免充值代金券金額，應(yīng)結(jié)訂單金額<=訂單金額。 示例值：100 |
| 貨幣種類 | fee_type | string[1,8] | 否 | 訂單金額貨幣類型，符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼，默認(rèn)人民幣：CNY，其他值列表詳見(jiàn)貨幣類型 示例值：CNY |
| 現(xiàn)金支付金額 | cash_fee | int | 是 | 現(xiàn)金支付金額，單位為分，只能為整數(shù)，詳見(jiàn)交易金額 示例值：100 |
| 現(xiàn)金退款金額 | cash_refund_fee | int | 否 | 現(xiàn)金退款金額，單位為分，只能為整數(shù)，詳見(jiàn)交易金額 示例值：100 |
| 代金券退款總金額 | coupon_refund_fee | int | 否 | 代金券退款金額<=退款金額，退款金額-代金券或立減優(yōu)惠退款金額為現(xiàn)金，說(shuō)明詳見(jiàn)代金券或立減優(yōu)惠 示例值：100 |
| 退款代金券使用數(shù)量 | coupon_refund_count | int | 否 | 退款代金券使用數(shù)量 示例值：1 |
| 代金券類型 | coupon_type_$n | string[1,8] | 否 | CASH：充值代金券 NO_CASH：非充值代金券 訂單使用代金券時(shí)有返回（取值：CASH、NO_CASH）。$n為下標(biāo),從0開始編號(hào)，舉例：coupon_type_0 示例值：CASH |
| 退款代金券ID | coupon_refund_id_$n | string[1,20] | 否 | 退款代金券ID，$n為下標(biāo)，從0開始編號(hào) 示例值：100 |
| 單個(gè)代金券退款金額 | coupon_refund_fee_$n | int | 否 | 單個(gè)退款代金券支付金額，$n為下標(biāo)，從0開始編號(hào) 示例值：100 |
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<sub_mch_id ><![CDATA[10000101]]></sub_mch_id >
<nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></nonce_str>
<sign><![CDATA[B7274EB9F8925EB93100DD2085FA56C0]]></sign>
<result_code><![CDATA[SUCCESS]]></result_code>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
<out_trade_no><![CDATA[1415757673]]></out_trade_no>
<out_refund_no><![CDATA[1415701182]]></out_refund_no>
<refund_id><![CDATA[2008450740201411110000174436]]></refund_id>
<refund_fee>1</refund_fee>?
</xml>| 錯(cuò)誤碼 | 描述 | 解決方案 |
|---|---|---|
| SYSTEMERROR | 接口返回錯(cuò)誤 | 請(qǐng)不要更換商戶退款單號(hào)，請(qǐng)使用相同參數(shù)再次調(diào)用API。 |
| BIZERR_NEED_RETRY | 退款業(yè)務(wù)流程錯(cuò)誤，需要商戶觸發(fā)重試來(lái)解決 | 請(qǐng)不要更換商戶退款單號(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)失敗，商戶可自行處理退款。 |
| 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)失敗，商戶可根據(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是否正確 |
| ORDERNOTEXIST | 訂單號(hào)不存在 | 請(qǐng)檢查你的訂單號(hào)是否正確且是否已支付，未支付的訂單不能發(fā)起退款 |
| REQUIRE_POST_METHOD | 請(qǐng)使用post方法 | 請(qǐng)檢查請(qǐng)求參數(shù)是否通過(guò)post方法提交 |
| SIGNERROR | 簽名錯(cuò)誤 | 請(qǐng)檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| XML_FORMAT_ERROR | XML格式錯(cuò)誤 | 請(qǐng)檢查XML參數(shù)格式是否正確 |
| FREQUENCY_LIMITED | 頻率限制 | 該筆退款未受理，請(qǐng)降低頻率后重試 |
| NOAUTH | 異常IP請(qǐng)求不予受理 | 如果是動(dòng)態(tài)ip，請(qǐng)登錄商戶平臺(tái)后臺(tái)關(guān)閉ip安全配置； 如果是靜態(tài)ip，請(qǐng)確認(rèn)商戶平臺(tái)配置的請(qǐng)求ip 在不在配的ip列表里 |
| CERT_ERROR | 證書校驗(yàn)錯(cuò)誤 | 請(qǐng)檢查證書是否正確，證書是否過(guò)期或作廢。 |
| REFUND_FEE_MISMATCH | 訂單金額或退款金額與之前請(qǐng)求不一致，請(qǐng)核實(shí)后再試 | 訂單金額或退款金額與之前請(qǐng)求不一致，請(qǐng)核實(shí)后再試 |
| INVALID_REQUEST | 請(qǐng)求參數(shù)符合參數(shù)格式，但不符合業(yè)務(wù)規(guī)則 | 此狀態(tài)代表退款申請(qǐng)失敗，商戶可根據(jù)具體的錯(cuò)誤提示做相應(yīng)的處理。 |
| ORDER_NOT_READY | 訂單處理中，暫時(shí)無(wú)法退款，請(qǐng)稍后再試 | 訂單處理中，暫時(shí)無(wú)法退款，請(qǐng)稍后再試 |