最新更新時(shí)間:2020.10.09 版本說明
提交退款申請后,通過調(diào)用該接口查詢退款狀態(tài)。該查詢服務(wù)提供兩種查詢方式(兩種查詢方式返回結(jié)果一致):
方式1:通過微信支付退款單號查詢退款;
方式2:通過商戶退款單號查詢退款。
● 退款有一定延時(shí),用零錢支付的退款20分鐘內(nèi)到賬,銀行卡支付的退款3個工作日后重新查詢退款狀態(tài)。
適用對象:電商平臺
請求URL:https://api.mch.weixin.qq.com/v3/ecommerce/refunds/id/{refund_id}
請求方式:GET
接口規(guī)則:http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path指該參數(shù)為路徑參數(shù)
query指該參數(shù)需在請求URL傳參
body指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
微信退款單號 | refund_id | string[1,32] | 是 | path
退款單的主鍵,唯一定義此資源的標(biāo)識。 示例值: 50000000382019052709732678859 |
二級商戶號 | sub_mchid | string[1,32] | 是 | query 微信支付分配給二級商戶的商戶號。 示例值:1900000109 |
https://api.mch.weixin.qq.com/v3/ecommerce/refunds/id/50000000382019052709732678859?sub_mchid=1900000109
適用對象:電商平臺
請求URL:https://api.mch.weixin.qq.com/v3/ecommerce/refunds/out-refund-no/{out_refund_no}
請求方式:GET
接口規(guī)則:http://www.tg885.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml
path指該參數(shù)為路徑參數(shù)
query指該參數(shù)需在請求URL傳參
body指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
商戶退款單號 | out_refund_no | string[1,32] | 是 | path
商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,同一退款單號多次請求只退一筆。 示例值:?1217752501201407033233368018 |
二級商戶號 | sub_mchid | string[1,32] | 是 | query 微信支付分配給二級商戶的商戶號。 示例值:1900000109 |
https://api.mch.weixin.qq.com/v3/ecommerce/applyments/out-request-no/APPLYMENT_00000000001?sub_mchid=1900000109
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
微信退款單號 | refund_id | string[1,32] | 是 | 微信支付退款訂單號。 示例值:1217752501201407033233368018 |
商戶退款單號 | out_refund_no | string[1,64] | 是 | 商戶系統(tǒng)內(nèi)部的退款單號,商戶系統(tǒng)內(nèi)部唯一,同一退款單號多次請求只退一筆。 示例值:1217752501201407033233368018 |
微信訂單號 | transaction_id | string[1,32] | 是 | 微信支付交易訂單號。 示例值: 1217752501201407033233368018 |
商戶訂單號 | out_trade_no | string[1,32] | 是 | 返回的原交易訂單號。 示例值: 1217752501201407033233368018 |
退款渠道 | channel | string[1,16] | 是 | ORIGINAL:原路退款 BALANCE:退回到余額 OTHER_BALANCE:原賬戶異常退到其他余額賬戶 OTHER_BANKCARD:原銀行卡異常退到其他銀行卡 示例值:?ORIGINAL |
退款入賬賬戶 | user_received_account | string[1,64] | 是 | 取當(dāng)前退款單的退款入賬方。 退回銀行卡:{銀行名稱}{卡類型}{卡尾號} 退回支付用戶零錢:支付用戶零錢 退還商戶:商戶基本賬戶、商戶結(jié)算銀行賬戶 退回支付用戶零錢通:支付用戶零錢通 示例值:?招商銀行信用卡0403 |
退款成功時(shí)間 | success_time | string[1,64] | 否 | 退款成功時(shí)間,退款狀態(tài)status為SUCCESS(退款成功)時(shí),返回該字段。遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35+08:00表示,北京時(shí)間2015年5月20日13點(diǎn)29分35秒。 示例值:?2018-06-08T10:34:56+08:00 |
退款創(chuàng)建時(shí)間 | create_time | string[1,64] | 是 | 1、退款受理時(shí)間,遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35+08:00表示,北京時(shí)間2015年5月20日13點(diǎn)29分35秒。 2、當(dāng)退款狀態(tài)為退款成功時(shí)返回此字段。 示例值:2018-06-08T10:34:56+08:00 |
退款狀態(tài) | status | string[1,16] | 是 | 退款狀態(tài),枚舉值: SUCCESS:退款成功 CLOSE:退款關(guān)閉 PROCESSING:退款處理中 ABNORMAL:退款異常,退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結(jié)了,導(dǎo)致原路退款銀行卡失敗,可前往【服務(wù)商平臺—>交易中心】,手動處理此筆退款 示例值:SUCCESS |
+退款金額信息 | amount | object | 是 | 訂單退款金額信息 |
+營銷詳情 | promotion_detail | array | 否 | 優(yōu)惠退款信息,discount_refund>0時(shí),返回該字段 |
{
"refund_id": "1217752501201407033233368018",
"out_refund_no": "1217752501201407033233368018",
"transaction_id": "1217752501201407033233368018",
"out_trade_no": "1217752501201407033233368018",
"channel": "ORIGINAL",
"user_received_account": "招商銀行信用卡0403",
"success_time": "2018-06-08T10:34:56+08:00",
"create_time": "2018-06-08T10:34:56+08:00",
"status": "SUCCESS",
"amount": {
"refund": 888,
"payer_refund": 888,
"discount_refund": 888,
"currency": "CNY"
},
"promotion_detail": [
{
"promotion_id": "109519",
"scope": "SINGLE",
"type": "DISCOUNT",
"amount": 5,
"refund_amount": 100
}
]
}
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 接口返回錯誤 | 請不要更換商戶退款單號,請使用相同參數(shù)再次調(diào)用API。 |
404 | RESOURCE_NOT_EXISTS | 訂單不存在 | 請檢查訂單號是否正確且是否已支付,未支付的訂單不能發(fā)起退款 |
400 | PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)錯誤,請重新檢查再調(diào)用退款申請 |
429 | FREQUENCY_LIMITED | 頻率限制 | 該筆退款未受理,請降低頻率后重試 |
403 | NO_AUTH | 沒有退款權(quán)限 | 此狀態(tài)代表退款申請失敗,請檢查是否有退這筆訂單的權(quán)限 |
401 | SIGN_ERROR | 簽名錯誤 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
400 | INVALID_REQUEST | 請求參數(shù)符合參數(shù)格式,但不符合業(yè)務(wù)規(guī)則 | 此狀態(tài)代表退款申請失敗,商戶可根據(jù)具體的錯誤提示做相應(yīng)的處理。 |
400 | MCH_NOT_EXISTS | 商戶號不存在 | 請檢查商戶號是否正確 |
403 | REQUEST_BLOCKED | 請求受阻 | 此狀態(tài)代表退款申請失敗,商戶可根據(jù)具體的錯誤提示做相應(yīng)的處理。 |