查詢退款
應(yīng)用場(chǎng)景
提交退款申請(qǐng)后，通過調(diào)用該接口查詢退款狀態(tài)。退款有一定延時(shí)，用零錢支付的退款20分鐘內(nèi)到賬，銀行卡支付的退款3個(gè)工作日后重新查詢退款狀態(tài)。
注意：如果單個(gè)支付訂單部分退款次數(shù)超過20次請(qǐng)使用退款單號(hào)查詢
分頁查詢
當(dāng)一個(gè)訂單部分退款超過10筆后，商戶用微信訂單號(hào)或商戶訂單號(hào)調(diào)退款查詢API查詢退款時(shí)，默認(rèn)返回前10筆和total_refund_count（訂單總退款次數(shù)）。商戶需要查詢同一訂單下超過10筆的退款單時(shí)，可傳入訂單號(hào)及offset來查詢，微信支付會(huì)返回offset及后面的10筆，以此類推。當(dāng)商戶傳入的offset超過total_refund_count，則系統(tǒng)會(huì)返回報(bào)錯(cuò)PARAM_ERROR。
舉例：
一筆訂單下的退款單有36筆，當(dāng)商戶想查詢第25筆時(shí)，可傳入訂單號(hào)及offset=24，微信支付平臺(tái)會(huì)返回第25筆到第35筆的退款單信息，或商戶可直接傳入退款單號(hào)查詢退款
接口地址
https://apihk.mch.weixin.qq.com/pay/refundquery （建議接入點(diǎn)：東南亞）
https://apius.mch.weixin.qq.com/pay/refundquery （建議接入點(diǎn)：其它）
https://api.mch.weixin.qq.com/pay/refundquery （建議接入點(diǎn)：中國國內(nèi)）
注：商戶可根據(jù)實(shí)際請(qǐng)求情況選擇最優(yōu)域名進(jìn)行訪問，建議在接入時(shí)做好兼容，當(dāng)訪問其中一個(gè)域名出現(xiàn)異常時(shí)，可自動(dòng)切換為其他域名。
是否需要證書
不需要。
請(qǐng)求參數(shù)
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公眾賬號(hào)ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公眾賬號(hào)ID（企業(yè)號(hào)corpid即為此appId） |
| 商戶號(hào) | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號(hào) |
| 隨機(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 |
| 微信訂單號(hào) | transaction_id | 四選一 | String(32) | 1217752501201407033233368018 | 微信訂單號(hào)查詢的優(yōu)先級(jí)是： refund_id > out_refund_no > transaction_id > out_trade_no |
| 商戶訂單號(hào) | out_trade_no | String(32) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部訂單號(hào)，要求32個(gè)字符內(nèi)，只能是數(shù)字、大小寫字母_-|*@ ，且在同一個(gè)商戶號(hào)下唯一。 | |
| 商戶退款單號(hào) | out_refund_no | String(64) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部的退款單號(hào)，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-|*@ ，同一退款單號(hào)多次請(qǐng)求只退一筆。 | |
| 微信退款單號(hào) | refund_id | String(32) | 1217752501201407033233368018 | 微信生成的退款單號(hào)，在申請(qǐng)退款接口有返回 |
|
| 偏移量 | offset | 否 | int | 15 | 偏移量，當(dāng)部分退款次數(shù)超過10次時(shí)可使用，表示返回的查詢結(jié)果從這個(gè)偏移量開始取記錄 |
舉例如下：
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
<out_refund_no></out_refund_no>
<out_trade_no>1415757673</out_trade_no>
<refund_id></refund_id>
<transaction_id></transaction_id>
<sign>66FFB727015F450D167EF38CCC549521</sign>
</xml>
返回?cái)?shù)據(jù)
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 返回信息 | return_msg | 否 | String(128) | 簽名失敗 | 返回信息，如非空，為錯(cuò)誤原因 簽名失敗 參數(shù)格式校驗(yàn)錯(cuò)誤 |
以下字段在return_code為SUCCESS的時(shí)候有返回
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 業(yè)務(wù)結(jié)果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL SUCCESS退款申請(qǐng)接收成功，結(jié)果通過退款查詢接口查詢 FAIL |
| 錯(cuò)誤碼 | err_code | 是 | String(32) | SYSTEMERROR | 錯(cuò)誤碼詳見第6節(jié) |
| 錯(cuò)誤描述 | err_code_des | 是 | String(128) | 系統(tǒng)錯(cuò)誤 | 結(jié)果信息描述 |
| 公眾賬號(hào)ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公眾賬號(hào)ID（企業(yè)號(hào)corpid即為此appId） |
| 商戶號(hào) | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號(hào) |
| 隨機(jī)字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機(jī)字符串，不長于32位 |
| 簽名 | sign | 是 | String(64) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名，詳見簽名算法 |
| 微信訂單號(hào) | transaction_id | 是 | String(32) | 1217752501201407033233368018 | 微信訂單號(hào) |
| 商戶訂單號(hào) | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部訂單號(hào)，要求32個(gè)字符內(nèi)，只能是數(shù)字、大小寫字母_-|*@ ，且在同一個(gè)商戶號(hào)下唯一。 |
| 標(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à)幣種 |
| 退款金額 | refund_fee_$n | 是 | int | 100 | 退款標(biāo)價(jià)金額,單位為分,可以做部分退款，標(biāo)價(jià)幣種跟標(biāo)價(jià)金額保持一致 |
| 訂單總退款次數(shù) | total_refund_count | 否 | int | 35 | 訂單總共已發(fā)生的部分退款次數(shù)，當(dāng)請(qǐng)求參數(shù)傳入offset后有返回 |
| 退款筆數(shù) | refund_count | 是 | int | 1 | 當(dāng)前返回退款筆數(shù) |
| 商戶退款單號(hào) | out_refund_no_$n | 是 | String(64) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部的退款單號(hào)，商戶系統(tǒng)內(nèi)部唯一，只能是數(shù)字、大小寫字母_-|*@ ，同一退款單號(hào)多次請(qǐng)求只退一筆。 |
| 微信退款單號(hào) | refund_id_$n | 是 | String(32) | 1217752501201407033233368018 | 微信退款單號(hào) |
| 退款渠道 | refund_channel_$n | 否 | String(16) | ORIGINAL | ORIGINAL—原路退款 BALANCE—退回到余額 OTHER_BALANCE—原賬戶異常退到其他余額賬戶 OTHER_BANKCARD—原銀行卡異常退到其他銀行卡 |
| 退款狀態(tài) | refund_status_$n | 是 | String(16) | SUCCESS | 退款狀態(tài)： SUCCESS—退款成功 REFUNDCLOSE—退款關(guān)閉。 PROCESSING—退款處理中 CHANGE—退款異常，退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結(jié)了，導(dǎo)致原路退款銀行卡失敗，可前往商戶平臺(tái)（www.tg885.com）-交易中心，手動(dòng)處理此筆退款。$n為下標(biāo)，從0開始編號(hào)。 |
| 退款資金來源 | refund_account_$n | 否 | String(30) | REFUND_SOURCE_RECHARGE_FUNDS | REFUND_SOURCE_RECHARGE_FUNDS---可用余額退款/基本賬戶 REFUND_SOURCE_UNSETTLED_FUNDS---未結(jié)算資金退款 $n為下標(biāo)，從0開始編號(hào)。 |
| 退款入賬賬戶 | refund_recv_accout_$n | 是 | String(64) | 招商銀行信用卡0403 | 取當(dāng)前退款單的退款入賬方
1）退回銀行卡： {銀行名稱}{卡類型}{卡尾號(hào)} 2）退回支付用戶零錢: 支付用戶零錢 3）退還商戶: 商戶基本賬戶 商戶結(jié)算銀行賬戶 4）退回支付用戶零錢通: 支付用戶零錢通 |
| 退款成功時(shí)間 | refund_success_time_$n | 否 | String(20) | 2016-07-25 15:26:26 | 退款成功時(shí)間，當(dāng)退款狀態(tài)為退款成功時(shí)有返回。$n為下標(biāo)，從0開始編號(hào)。 |
| 匯率 | rate | 是 | String(16) | 650000000 | 標(biāo)價(jià)幣種與支付幣種的兌換比例乘以10的8次方即為此值，例如美元兌換人民幣的比例為6.5，則rate=650000000 |
舉例如下：
<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>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
</xml>
錯(cuò)誤碼
| 名稱 | 描述 | 原因 | 解決方案 |
|---|---|---|---|
| SYSTEMERROR | 接口返回錯(cuò)誤 | 系統(tǒng)超時(shí) | 請(qǐng)嘗試再次掉調(diào)用API。 |
| REFUNDNOTEXIST | 退款訂單查詢失敗 | 訂單號(hào)錯(cuò)誤或訂單狀態(tài)不正確 | 請(qǐng)檢查訂單號(hào)是否有誤以及訂單狀態(tài)是否正確，如：未支付、已支付未退款 |
| INVALID_TRANSACTIONID | 無效transaction_id | 請(qǐng)求參數(shù)未按指引進(jìn)行填寫 | 請(qǐng)求參數(shù)錯(cuò)誤，檢查原交易號(hào)是否存在或發(fā)起支付交易接口返回失敗 |
| PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)求參數(shù)未按指引進(jìn)行填寫 | 請(qǐng)求參數(shù)錯(cuò)誤，請(qǐng)檢查參數(shù)再調(diào)用退款申請(qǐng) |
| APPID_NOT_EXIST | APPID不存在 | 參數(shù)中缺少APPID | 請(qǐng)檢查APPID是否正確 |
| MCHID_NOT_EXIST | MCHID不存在 | 參數(shù)中缺少M(fèi)CHID | 請(qǐng)檢查MCHID是否正確 |
| REQUIRE_POST_METHOD | 請(qǐng)使用post方法 | 未使用post傳遞參數(shù) | 請(qǐng)檢查請(qǐng)求參數(shù)是否通過post方法提交 |
| SIGNERROR | 簽名錯(cuò)誤 | 參數(shù)簽名結(jié)果不正確 | 請(qǐng)檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| XML_FORMAT_ERROR | XML格式錯(cuò)誤 | XML格式錯(cuò)誤 | 請(qǐng)檢查XML參數(shù)格式是否正確 |