最新更新時間:2020.5.08 版本說明
提交退款申請后,通過調(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。
適用對象:直連模式機構模式
請求URL:https://api.mch.weixin.qq.com/pay/refundquery
請求方式: POST
是否需要證書: 不需要
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
公眾賬號ID | appid | string(32) | 是 | 微信分配的公眾賬號ID(企業(yè)號corpid即為此appId) 示例值:wx8888888888888888 |
商戶號 | mch_id | string(32) | 是 | 微信支付分配的商戶號 示例值:1900000109 |
子商戶公眾賬號ID | sub_appid | string(32) | 否 | 微信分配的子商戶公眾賬號ID 注意:僅適用于機構模式 示例值:wx8888888888888888 |
子商戶號 | sub_mch_id | string(32) | 是 | 微信支付分配的子商戶號 注意:僅適用于機構模式 示例值:1900000109 |
隨機字符串 | nonce_str | string(32) | 是 | 隨機字符串,不長于32位。推薦隨機數(shù)生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string(64) | 是 | 簽名,詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
簽名類型 | sign_type | string(32) | 否 | 簽名類型,目前支持HMAC-SHA256和MD5,默認為MD5 示例值:HMAC-SHA256 |
微信訂單號 | transaction_id | string(32) | 四選一 | 微信訂單號查詢的優(yōu)先級是: refund_id > out_refund_no > transaction_id > out_trade_no 示例值:1217752501201407033233368018 |
商戶訂單號 | out_trade_no | string(32) | 商戶系統(tǒng)內(nèi)部訂單號,要求32個字符內(nèi),只能是數(shù)字、大小寫字母_-|*@ ,且在同一個商戶號下唯一。 示例值:1217752501201407033233368018 |
|
商戶退款單號 | out_refund_no | string(64) | 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號多次請求只退一筆。 示例值:1217752501201407033233368018 |
|
微信退款單號 | refund_id | String(32) | 微信生成的退款單號,在申請退款接口有返回 示例值:1217752501201407033233368018 |
|
偏移量 | offset | int | 否 | 偏移量,當部分退款次數(shù)超過10次時可使用,表示返回的查詢結果從這個偏移量開始取記錄 示例值:15 |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
<out_refund_no>1415701182</out_refund_no>
<refund_id></refund_id>
<transaction_id>4008450740201411110005820873</transaction_id>
<sign>66FFB727015F450D167EF38CCC549521</sign>
</xml>
字段名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string(16) | 是 | SUCCESS/FAIL 示例值:SUCCESS |
返回信息 | return_msg | string(128) | 否 | 返回信息,如非空,為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 示例值:簽名失敗 |
以下字段在return_code為SUCCESS的時候有返回
字段名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
業(yè)務結果 | result_code | String(16) | 是 | SUCCESS/FAIL SUCCESS退款申請接收成功,退款結果通過退款狀態(tài)為準 FAIL 示例值:SUCCESS |
錯誤代碼 | err_code | String(32) | 是 | 錯誤碼詳見第6節(jié) 示例值:SYSTEMERROR |
錯誤描述 | err_code_des | String(128) | 是 | 結果信息描述 示例值:系統(tǒng)錯誤 |
公眾賬號ID | appid | String(32) | 是 | 微信分配的公眾賬號ID 示例值:wx8888888888888888 |
商戶號 | mch_id | String(32) | 是 | 微信支付分配的商戶號 示例值:1900000109 |
子商戶公眾賬號ID | sub_appid | String(32) | 否 | 微信分配的子商戶公眾賬號ID 注意:僅適用于機構模式 示例值:wx8888888888888888 |
子商戶號 | sub_mch_id | String(32) | 是 | 微信支付分配的子商戶號 注意:僅適用于機構模式 示例值:1900000109 |
隨機字符串 | nonce_str | String(32) | 是 | 隨機字符串,不長于32位。 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | String(64) | 是 | 簽名,詳見簽名生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
微信訂單號 | transaction_id | String(32) | 是 | 微信訂單號 示例值:1217752501201407033233368018 |
商戶訂單號 | out_trade_no | String(32) | 是 | 商戶系統(tǒng)內(nèi)部訂單號,要求32個字符內(nèi),只能是數(shù)字、大小寫字母_-|*@ ,且在同一個商戶號下唯一。 示例值:1217752501201407033233368018 |
標價金額 | total_fee | int | 是 | 訂單總金額,單位為分,只能為整數(shù),詳見支付金額 示例值:100 |
標價幣種 | fee_type | String(8) | 否 | 訂單金額貨幣類型,符合ISO 4217標準的三位字母代碼,列表詳見貨幣類型 示例值:USD |
現(xiàn)金支付金額 | cash_fee | int | 否 | 訂單現(xiàn)金支付金額,詳見支付金額 示例值:100 |
退款金額 | refund_fee_$n | int | 是 | 退款總金額,單位為分,可以做部分退款 示例值:100 |
訂單總退款次數(shù) | total_refund_count | int | 否 | 訂單總共已發(fā)生的部分退款次數(shù),當請求參數(shù)傳入offset后有返回 示例值:35 |
退款筆數(shù) | refund_count | int | 是 | 當前返回退款筆數(shù) 示例值:1 |
商戶退款單號 | out_refund_no_$n | String(64) | 是 | 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫字母_-|*@ ,同一退款單號多次請求只退一筆。 示例值:1217752501201407033233368018 |
微信退款單號 | refund_id_$n | String(32) | 是 | 微信退款單號 示例值:1217752501201407033233368018 |
退款渠道 | refund_channel_$n | String(16) | 否 | ORIGINAL:原路退款 BALANCE:退回到余額 OTHER_BALANCE:原賬戶異常退到其他余額賬戶 OTHER_BANKCARD:原銀行卡異常退到其他銀行卡 示例值:ORIGINAL |
退款狀態(tài) | refund_status_$n | String(16) | 是 |
退款狀態(tài): SUCCESS:退款成功 REFUNDCLOSE:退款關閉。 PROCESSING:退款處理中 CHANGE:退款異常,退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結了,導致原路退款銀行卡失敗,可前往商戶平臺(www.tg885.com)-交易中心,手動處理此筆退款。$n為下標,從0開始編號。 示例值:SUCCESS |
退款資金來源 | refund_account_$n | String(16) | 否 |
REFUND_SOURCE_RECHARGE_FUNDS:可用余額退款/基本賬戶 REFUND_SOURCE_UNSETTLED_FUNDS:未結算資金退款 $n為下標,從0開始編號。 示例值:REFUND_SOURCE_RECHARGE_FUNDS |
退款入賬賬戶 | refund_recv_accout_$n | String(16) | 是 |
取當前退款單的退款入賬方 1)退回銀行卡: {銀行名稱}{卡類型}{卡尾號} 2)退回支付用戶零錢: 支付用戶零錢 3)退還商戶: 商戶基本賬戶 商戶結算銀行賬戶 4)退回支付用戶零錢通: 支付用戶零錢通 示例值:招商銀行信用卡0403 |
退款成功時間 | refund_success_time_$n | String(20) | 否 |
退款成功時間,當退款狀態(tài)為退款成功時有返回。$n為下標,從0開始編號。 示例值:2016-07-25 15:26:26 |
匯率 | rate | String(16) | 否 |
外幣兌換RMB的比例乘以10的8次方即為此值,例如美元兌換人民幣的比例為6.5,則rate=650000000 示例值:650000000 |
<xml>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></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>
錯誤碼 | 描述 | 原因 | 解決方案 |
---|---|---|---|
SYSTEMERROR | 接口返回錯誤 | 系統(tǒng)超時 | 請嘗試再次掉調(diào)用API。 |
REFUNDNOTEXIST | 退款訂單查詢失敗 | 訂單號錯誤或訂單狀態(tài)不正確 | 請檢查訂單號是否有誤以及訂單狀態(tài)是否正確,如:未支付、已支付未退款 |
INVALID_TRANSACTIONID | 無效transaction_id | 請求參數(shù)未按指引進行填寫 | 請求參數(shù)錯誤,檢查原交易號是否存在或發(fā)起支付交易接口返回失敗 |
PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)未按指引進行填寫 | 請求參數(shù)錯誤,請檢查參數(shù)再調(diào)用退款申請 |
APPID_NOT_EXIST | APPID不存在 | 參數(shù)中缺少APPID | 請檢查APPID是否正確 |
MCHID_NOT_EXIST | MCHID不存在 | 參數(shù)中缺少MCHID | 請檢查MCHID是否正確 |
REQUIRE_POST_METHOD | 請使用post方法 | 未使用post傳遞參數(shù) | 請檢查請求參數(shù)是否通過post方法提交 |
SIGNERROR | 簽名錯誤 | 參數(shù)簽名結果不正確 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
XML_FORMAT_ERROR | XML格式錯誤 | XML格式錯誤 | 請檢查XML參數(shù)格式是否正確 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證