申請退款
應(yīng)用場景
當(dāng)交易發(fā)生之后一段時(shí)間內(nèi),由于買家或者賣家的原因需要退款時(shí),賣家可以通過退款接口將支付款退還給買家,微信支付將在收到退款請求并且驗(yàn)證成功之后,按照退款規(guī)則將支付款按原路退到買家賬號上。
注意:
1、交易時(shí)間超過一年的訂單無法提交退款;
2、微信支付退款支持單筆交易分多次退款,多次退款需要提交原支付訂單的商戶訂單號和設(shè)置不同的退款單號。申請退款總金額不能超過訂單金額。 一筆退款失敗后重新提交,請不要更換退款單號,請使用原商戶退款單號。
3、請求頻率限制:150qps,即每秒鐘正常的申請退款請求次數(shù)不超過150次
錯誤或無效請求頻率限制:6qps,即每秒鐘異常或錯誤的退款申請請求不超過6次
4、每個(gè)支付訂單的部分退款次數(shù)不能超過50次
5、如果同一個(gè)用戶有多筆退款,建議分不同批次進(jìn)行退款,避免并發(fā)退款導(dǎo)致退款失敗
接口地址
https://apihk.mch.weixin.qq.com/secapi/pay/refund (建議接入點(diǎn):東南亞)
https://apius.mch.weixin.qq.com/secapi/pay/refund (建議接入點(diǎn):其它)
https://api.mch.weixin.qq.com/secapi/pay/refund (建議接入點(diǎn):中國國內(nèi))
注:商戶可根據(jù)實(shí)際請求情況選擇最優(yōu)域名進(jìn)行訪問,建議在接入時(shí)做好兼容,當(dāng)訪問其中一個(gè)域名出現(xiàn)異常時(shí),可自動切換為其他域名。
是否需要證書
請求需要雙向證書。 詳見證書使用
請求參數(shù)
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
公眾賬號ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公眾賬號ID(企業(yè)號corpid即為此appId) |
商戶號 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號 |
隨機(jī)字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機(jī)字符串,不長于32位。推薦隨機(jī)數(shù)生成算法 |
簽名 | sign | 是 | String(64) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名,詳見簽名生成算法 |
簽名類型 | sign_type | 否 | String(32) | HMAC-SHA256 | 簽名類型,目前支持HMAC-SHA256和MD5,默認(rèn)為MD5 |
微信訂單號 | transaction_id | 二選一 | String(32) | 1217752501201407033233368018 | 微信生成的訂單號,在支付通知中有返回 |
商戶訂單號 | out_trade_no | String(32) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部訂單號,要求32個(gè)字符內(nèi),只能是數(shù)字、大小寫字母_-|*@ ,且在同一個(gè)商戶號下唯一。 transaction_id、out_trade_no二選一,如果同時(shí)存在優(yōu)先級:transaction_id> out_trade_no |
|
商戶退款單號 | out_refund_no | 是 | String(64) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號多次請求只退一筆。 |
標(biāo)價(jià)金額 | total_fee | 是 | int | 888 | 標(biāo)價(jià)金額,單位為該幣種最小計(jì)算單位,只能為整數(shù),詳見標(biāo)價(jià)金額 |
退款金額 | refund_fee | 是 | int | 100 | 退款總金額,訂單總金額,單位為分,只能為整數(shù),詳見支付金額 |
商戶退款幣種 | refund_fee_type | 否 | String(8) | GBP | 退款幣種必須和標(biāo)價(jià)幣種一致,幣種列表詳見標(biāo)價(jià)幣種 |
退款原因 | refund_desc | 否 | String(80) | 商品已售完 | 若商戶傳入,會在下發(fā)給用戶的退款消息中體現(xiàn)退款原因 注意:若訂單退款金額≤1元,且屬于部分退款,則不會在退款消息中體現(xiàn)退款原因 |
退款結(jié)果通知url | notify_url | 否 | String(256) | https://weixin.qq.com/notify/ | 異步接收微信支付退款結(jié)果通知的回調(diào)地址,通知URL必須為外網(wǎng)可訪問的url,不允許帶參數(shù) |
舉例如下:
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
<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>4008450740201411110005820873</transaction_id>
<sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>
返回結(jié)果
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
返回信息 | return_msg | 否 | String(128) | 簽名失敗 | 返回信息,如非空,為錯誤原因 簽名失敗 參數(shù)格式校驗(yàn)錯誤 |
以下字段在return_code為SUCCESS的時(shí)候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
業(yè)務(wù)結(jié)果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL SUCCESS退款申請接收成功,結(jié)果通過退款查詢接口查詢 FAIL 提交業(yè)務(wù)失敗 |
錯誤代碼 | err_code | 否 | String(32) | SYSTEMERROR | 列表詳見第6節(jié) |
錯誤代碼描述 | err_code_des | 否 | String(128) | 系統(tǒng)超時(shí) | 結(jié)果信息描述 |
公眾賬號ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公眾賬號ID |
商戶號 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號 |
隨機(jī)字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機(jī)字符串,不長于32位 |
簽名 | sign | 是 | String(64) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 簽名,詳見簽名算法 |
微信訂單號 | transaction_id | 是 | String(32) | 1217752501201407033233368018 | 微信訂單號 |
商戶訂單號 | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部訂單號,要求32個(gè)字符內(nèi),只能是數(shù)字、大小寫字母_-|*@ ,且在同一個(gè)商戶號下唯一。 |
商戶退款單號 | out_refund_no | 是 | String(64) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號多次請求只退一筆。 |
微信退款單號 | refund_id | 是 | String(32) | 1217752501201407033233368018 | 微信退款單號 |
退款金額 | refund_fee | 是 | int | 100 | 退款標(biāo)價(jià)金額,單位為分,可以做部分退款 |
退款幣種 | refund_fee_type | 是 | String(8) | GBP | 符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,詳見標(biāo)價(jià)幣種,注:退款幣種與支付幣種必須一致 |
標(biāo)價(jià)金額 | total_fee | 是 | int | 888 | 標(biāo)價(jià)金額,單位為該幣種最小計(jì)算單位,只能為整數(shù),詳見標(biāo)價(jià)金額 |
標(biāo)價(jià)幣種 | fee_type | 是 | String(8) | GBP | 符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,詳見標(biāo)價(jià)幣種 |
用戶支付金額 | cash_fee | 是 | int | 100 | 訂單現(xiàn)金支付金額,詳見支付金額 |
用戶支付金額幣種 | cash_fee_type | 是 | String(8) | CNY | 符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,詳見標(biāo)價(jià)幣種 |
用戶支付退款金額 | cash_refund_fee | 是 | int | 100 | 現(xiàn)金退款金額,單位為分,只能為整數(shù),詳見支付金額 |
用戶支付退款幣種 | cash_refund_fee_type | 否 | String(8) | GBP | 符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,詳見標(biāo)價(jià)幣種 |
舉例如下:
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></nonce_str>
<sign><![CDATA[B7274EB9F8925EB93100DD2085FA56C0]]></sign>
<result_code><![CDATA[SUCCESS]]></result_code>
<transaction_id><![CDATA[4008450740201411110005820873]]></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 | 接口返回錯誤 | 系統(tǒng)超時(shí) | 請不要更換商戶退款單號,請使用相同參數(shù)再次調(diào)用API。 |
BIZERR_NEED_RETRY | 退款業(yè)務(wù)流程錯誤,需要商戶觸發(fā)重試來解決 | 并發(fā)情況下,業(yè)務(wù)被拒絕,商戶重試即可解決 | 請不要更換商戶退款單號,請使用相同參數(shù)再次調(diào)用API。 |
TRADE_OVERDUE | 訂單已經(jīng)超過退款期限 | 訂單已經(jīng)超過可退款的最大期限(支付后一年內(nèi)可退款) | 請選擇其他方式自行退款 |
ERROR | 業(yè)務(wù)錯誤 | 申請退款業(yè)務(wù)發(fā)生錯誤 | 該錯誤都會返回具體的錯誤原因,請根據(jù)實(shí)際返回做相應(yīng)處理。 |
USER_ACCOUNT_ABNORMAL | 退款請求失敗 | 用戶賬號注銷 | 此狀態(tài)代表退款申請失敗,商戶可自行處理退款。 |
INVALID_REQ_TOO_MUCH | 無效請求過多 | 連續(xù)錯誤請求數(shù)過多被系統(tǒng)短暫屏蔽 | 請檢查業(yè)務(wù)是否正常,確認(rèn)業(yè)務(wù)正常后請?jiān)?分鐘后再來重試 | NOTENOUGH | 余額不足 | 商戶可用退款余額不足 | 此狀態(tài)代表退款申請失敗,商戶可根據(jù)具體的錯誤提示做相應(yīng)的處理。 |
INVALID_TRANSACTIONID | 無效transaction_id | 請求參數(shù)未按指引進(jìn)行填寫 | 請求參數(shù)錯誤,檢查原交易號是否存在或發(fā)起支付交易接口返回失敗 |
PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)未按指引進(jìn)行填寫 | 請求參數(shù)錯誤,請重新檢查再調(diào)用退款申請 |
APPID_NOT_EXIST | APPID不存在 | 參數(shù)中缺少APPID | 請檢查APPID是否正確 |
MCHID_NOT_EXIST | MCHID不存在 | 參數(shù)中缺少M(fèi)CHID | 請檢查MCHID是否正確 |
ORDERNOTEXIST | 訂單號不存在 | 缺少有效的訂單號 | 請檢查你的訂單號是否正確且是否已支付,未支付的訂單不能發(fā)起退款 |
REQUIRE_POST_METHOD | 請使用post方法 | 未使用post傳遞參數(shù) | 請檢查請求參數(shù)是否通過post方法提交 |
SIGNERROR | 簽名錯誤 | 參數(shù)簽名結(jié)果不正確 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
XML_FORMAT_ERROR | XML格式錯誤 | XML格式錯誤 | 請檢查XML參數(shù)格式是否正確 |
FREQUENCY_LIMITED | 頻率限制 | 2個(gè)月之前的訂單申請退款有頻率限制 | 該筆退款未受理,請降低頻率后重試 |
NOAUTH | 異常IP請求不予受理 | 請求ip異常 | 如果是動態(tài)ip,請登錄商戶平臺后臺關(guān)閉ip安全配置; 如果是靜態(tài)ip,請確認(rèn)商戶平臺配置的請求ip?在不在配的ip列表里?? |
CERT_ERROR | 證書校驗(yàn)錯誤 | 請檢查證書是否正確,證書是否過期或作廢。 | 請檢查證書是否正確,證書是否過期或作廢。 |
REFUND_FEE_MISMATCH | 訂單金額或退款金額與之前請求不一致,請核實(shí)后再試 | 訂單金額或退款金額與之前請求不一致,請核實(shí)后再試 | 訂單金額或退款金額與之前請求不一致,請核實(shí)后再試 |