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