最新更新時間：2020.10.10 版本說明
提交退款申請后，通過調(diào)用該接口查詢退款狀態(tài)。退款有一定延時，用零錢支付的退款20分鐘內(nèi)到賬，銀行卡支付的退款3個工作日后重新查詢退款狀態(tài)。
如果單個支付訂單部分退款次數(shù)超過20次請使用退款單號查詢
分頁查詢
● 當一個訂單部分退款超過10筆后，商戶用微信訂單號或商戶訂單號調(diào)退款查詢API查詢退款時，默認返回前10筆和total_refund_count（退款單總筆數(shù)）。商戶需要查詢同一訂單下超過10筆的退款單時，可傳入訂單號及offset來查詢，微信支付會返回offset及后面的10筆，以此類推。當商戶傳入的offset超過total_refund_count，則系統(tǒng)會返回報錯PARAM_ERROR。
舉例：一筆訂單下的退款單有36筆，當商戶想查詢第25筆時，可傳入訂單號及offset=24，微信支付平臺會返回第25筆到第35筆的退款單信息，或商戶可直接傳入退款單號查詢退款
適用對象：直連商戶 服務商
請求URL： https://api.mch.weixin.qq.com/pay/refundquery
冗災備用URL：https://api.mch.weixin.qq.com/pay/refundquery(備用域名)見跨城冗災方案
請求方式： POST
數(shù)據(jù)格式： XML
是否需要證書： 需要雙向證書。 詳見證書使用
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 應用ID | appid | string[1,32] | 是 | 微信分配的應用ID 示例值：wx8888888888888888 |
| 商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值：1900000109 |
| 子商戶應用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應用ID，如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意：僅適用于服務商模式 示例值：wx8888888888888888 |
| 子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 注意：僅適用于服務商模式 示例值：1900000109 |
| 隨機字符串 | nonce_str | string[1,32] | 是 | 隨機字符串，不長于32位。推薦隨機數(shù)生成算法 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
| 簽名 | sign | string[1,64] | 是 | 簽名，詳見簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 微信退款單號 | refund_id | string[1,32] | 四選一 | 微信退款單號 注意：查詢的優(yōu)先級是： 微信退款單號 > 商戶退款單號 > 微信支付訂單號 > 商戶訂單號 示例值：1217752501201407033233368018 |
| 商戶退款單號 | out_refund_no | string[1,64] | 商戶系統(tǒng)內(nèi)部的退款單號，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-|*@ ，同一退款單號多次請求只退一筆。 示例值：1217752501201407033233368018 |
|
| 微信支付訂單號 | transaction_id | string[1,32] | 微信的訂單號，優(yōu)先使用 示例值：1217752501201407033233368018 |
|
| 商戶訂單號 | out_trade_no | string[1,32] | 商戶系統(tǒng)內(nèi)部訂單號，要求32個字符內(nèi)，只能是數(shù)字、大小寫字母_-|*@ ，且在同一個商戶號下唯一。 示例值：1217752501201407033233368018 |
|
| 偏移量 | offset | int | 否 | 偏移量，當部分退款次數(shù)超過10次時可使用，表示返回的查詢結(jié)果從這個偏移量開始取記錄 示例值：15 |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
<out_refund_no>123456789</out_refund_no>
<out_trade_no>1415757673</out_trade_no>
<sub_mch_id>1900000109</sub_mch_id>
<sign>66FFB727015F450D167EF38CCC549521</sign>
</xml>
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標識，非交易標識，交易是否成功需要查看result_code來判斷 示例值：SUCCESS |
| 返回信息 | return_msg | string[1,128] | 否 | 返回信息，如非空，為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 示例值：簽名失敗 |
返回狀態(tài)碼(return_code)為SUCCESS的時候,包含以下字段
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 業(yè)務結(jié)果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值：SUCCESS |
| 錯誤代碼 | err_code | string[1,32] | 否 | 詳細參見錯誤列表 示例值：SYSTEMERROR |
| 錯誤代碼描述 | err_code_des | string[1,128] | 否 | 結(jié)果信息描述 示例值：系統(tǒng)錯誤 |
| 應用ID | appid | string[1,32] | 是 | 微信分配的應用ID 示例值：wx8888888888888888 |
| 商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值：1900000109 |
| 子商戶應用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應用ID，如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意：僅適用于服務商模式 示例值：wx8888888888888888 |
| 子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 注意：僅適用于服務商模式 示例值：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 |
| 標價金額 | total_fee | int | 是 | 訂單總金額，單位為分 示例值：100 |
| 標價幣種 | fee_type | string[1,8] | 否 | 貨幣類型，符合ISO4217標準的三位字母代碼，默認人民幣：CNY，其他值列表詳見貨幣類型 示例值：CNY |
| 應結(jié)訂單金額 | settlement_total_fee | int | 否 | 當訂單使用了免充值型優(yōu)惠券后返回該參數(shù)，應結(jié)訂單金額=訂單金額-免充值優(yōu)惠券金額。 示例值：100 |
| 現(xiàn)金支付金額 | cash_fee | int | 是 | 現(xiàn)金支付金額訂單現(xiàn)金支付金額，詳見交易金額 示例值：100 |
| 退款筆數(shù) | refund_count | int | 是 | 當前返回退款筆數(shù) 示例值：1 |
| 商戶退款單號 | out_refund_no | string[1,64] | 是 | 商戶系統(tǒng)內(nèi)部的退款單號，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-|*@ ，同一退款單號多次請求只退一筆。 示例值：1217752501201407033233368018 |
| 微信退款單號 | refund_id | string[1,32] | 是 | 微信退款單號 示例值：1217752501201407033233368018 |
| 退款渠道 | refund_channel_$n | string[1,16] | 否 | 枚舉值： ORIGINAL：原路退款 BALANCE：退回到余額 OTHER_BALANCE：原賬戶異常退到其他余額賬戶 OTHER_BANKCARD：原銀行卡異常退到其他銀行卡 示例值：ORIGINAL |
| 訂單總退款次數(shù) | total_refund_count | int | 否 | 訂單總共已發(fā)生的部分退款次數(shù)，當請求參數(shù)傳入offset后有返回 示例值：35 |
| 申請退款金額 | refund_fee_$n | int | 是 | 退款總金額,單位為分,可以做部分退款，$n為下標，從0開始編號 示例值：100 |
| 退款金額 | settlement_refund_fee | int | 否 | 去掉非充值代金券退款金額后的退款金額，退款金額=申請退款金額-非充值代金券退款金額，退款金額<=申請退款金額 示例值：100 |
| 代金券類型 | coupon_type_$n | string[1,8] | 否 | CASH：充值代金券 NO_CASH：非充值代金券 訂單使用代金券時有返回（取值：CASH、NO_CASH）。$n為下標,從0開始編號，舉例：coupon_type_0 示例值：CASH |
| 總代金券退款金額 | coupon_refund_fee_$n | int | 否 | 代金券退款金額<=退款金額，退款金額-代金券或立減優(yōu)惠退款金額為現(xiàn)金，說明詳見代金券或立減優(yōu)惠 示例值：100 |
| 退款代金券使用數(shù)量 | coupon_refund_count_$n | int | 否 | 退款代金券使用數(shù)量，$n為下標,從0開始編號 示例值：1 |
| 退款代金券ID | coupon_refund_id_$n_$m | string[1,20] | 否 | 退款代金券ID，$n為下標，$m為下標，從0開始編號 示例值：10000 |
| 單個代金券退款金額 | coupon_refund_fee_$n_$m | int | 否 | 單個退款代金券支付金額，$n為下標，$m為下標，從0開始編號 示例值：100 |
| 退款狀態(tài) | refund_status_$n | string[1,16] | 是 | 退款狀態(tài)： SUCCESS：退款成功 REFUNDCLOSE：退款關(guān)閉。 PROCESSING：退款處理中 CHANGE：退款異常，退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結(jié)了，導致原路退款銀行卡失敗，可前往商戶平臺（www.tg885.com）-交易中心，手動處理此筆退款。$n為下標，從0開始編號。 示例值：SUCCESS |
| 退款資金來源 | refund_account_$n | string[1,30] | 否 | REFUND_SOURCE_RECHARGE_FUNDS：可用余額退款/基本賬戶 REFUND_SOURCE_UNSETTLED_FUNDS：未結(jié)算資金退款 $n為下標，從0開始編號。 示例值：REFUND_SOURCE_RECHARGE_FUNDS |
| 退款入賬賬戶 | refund_recv_accout_$n | string[1,64] | 是 | 取當前退款單的退款入賬方 1）退回銀行卡： {銀行名稱}{卡類型}{卡尾號} 2）退回支付用戶零錢: 支付用戶零錢 3）退還商戶: 商戶基本賬戶 商戶結(jié)算銀行賬戶 4）退回支付用戶零錢通: 支付用戶零錢通 示例值：招商銀行信用卡0403 |
| 退款成功時間 | refund_success_time_$n | string[1,20] | 否 | 退款成功時間，當退款狀態(tài)為退款成功時有返回。$n為下標，從0開始編號。 示例值：2016-07-25 15:26:26 |
<xml>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[TeqClE3i0mvn3DrK]]></nonce_str>
??<out_refund_no_0><![CDATA[1415701182]]></out_refund_no_0>
??<out_trade_no><![CDATA[1415757673]]></out_trade_no>
??<refund_count>1</refund_count>
??<refund_fee_0>1</refund_fee_0>
??<refund_id_0><![CDATA[2008450740201411110000174436]]></refund_id_0>
??<refund_status_0><![CDATA[PROCESSING]]></refund_status_0>
??<result_code><![CDATA[SUCCESS]]></result_code>
??<return_code><![CDATA[SUCCESS]]></return_code>
??<return_msg><![CDATA[OK]]></return_msg>
??<sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign>
??<refund_recv_accout_0><![CDATA[1F2841558E233C33ABA71A961D27561C]]></refund_recv_accout_0>
??<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
</xml>| 錯誤碼 | 描述 | 解決方案 |
|---|---|---|
| SYSTEMERROR | 接口返回錯誤 | 請嘗試再次掉調(diào)用API。 |
| REFUNDNOTEXIST | 退款訂單查詢失敗 | 請檢查訂單號是否有誤以及訂單狀態(tài)是否正確，如：未支付、已支付未退款 |
| INVALID_TRANSACTIONID | 無效transaction_id | 請求參數(shù)錯誤，檢查原交易號是否存在或發(fā)起支付交易接口返回失敗 |
| PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)錯誤，請檢查參數(shù)再調(diào)用退款申請 |
| APPID_NOT_EXIST | APPID不存在 | 請檢查APPID是否正確 |
| MCHID_NOT_EXIST | MCHID不存在 | 請檢查MCHID是否正確 |
| REQUIRE_POST_METHOD | 請使用post方法 | 請檢查請求參數(shù)是否通過post方法提交 |
| SIGNERROR | 簽名錯誤 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| XML_FORMAT_ERROR | XML格式錯誤 | 請檢查XML參數(shù)格式是否正確 |
| INVALID_REQUEST | 請求參數(shù)符合參數(shù)格式，但不符合業(yè)務規(guī)則 | 此狀態(tài)代表退款申請失敗，商戶可根據(jù)具體的錯誤提示做相應的處理。 |