查詢單筆退款A(yù)PI
最新更新時(shí)間:2023.10.20 版本說(shuō)明
提交退款申請(qǐng)后,通過(guò)調(diào)用該接口查詢退款狀態(tài)。退款有一定延時(shí),用零錢支付的退款20分鐘內(nèi)到賬,銀行卡支付的退款3個(gè)工作日后重新查詢退款狀態(tài)。
提交退款申請(qǐng)后,通過(guò)調(diào)用該接口查詢退款狀態(tài)。退款有一定延時(shí),用零錢支付的退款20分鐘內(nèi)到賬,銀行卡支付的退款3個(gè)工作日后重新查詢退款狀態(tài)。
適用對(duì)象:直連模式機(jī)構(gòu)模式
請(qǐng)求URL:https://apihk.mch.weixin.qq.com/v3/global/refunds/id/{refund_id}
或
https://apihk.mch.weixin.qq.com/v3/global/refunds/out-refund-no/{out_refund_no}
請(qǐng)求方式: GET
頻率限制:150qps
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
商戶號(hào) | mchid | string[1,32] | 是 | Query 微信支付分配的商戶號(hào) 注意:僅適用于直連模式 示例值:1900000109 |
子商戶號(hào) | sub_mchid | string[1,32] | 是 | Query 微信支付分配的子商戶號(hào) 注意:僅適用于機(jī)構(gòu)模式 示例值:1900000109 |
機(jī)構(gòu)商戶號(hào) | sp_mchid | string[1,32] | 是 | Query 微信支付分配的機(jī)構(gòu)商戶號(hào) 注意:僅適用于機(jī)構(gòu)模式 示例值:1900000100 |
商戶退款訂單號(hào) | out_refund_no | string[1,64] | 二選一 | Path返回的商戶退款訂單號(hào) 示例值:1217752501201407033233368018 |
微信支付退款訂單號(hào) | refund_id | string[1,32] | Path微信支付退款訂單號(hào) 示例值:1217752501201407033233368018 |
https://apihk.mch.weixin.qq.com/v3/global/refunds/id/50201308462021060109285031309?sp_mchid=126464383&sub_mchid=426157911
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
微信支付退款訂單號(hào) | id | string[1,32] | 二選一 | 微信支付退款訂單訂單號(hào) 示例值:1217752501201407033233368018 |
商戶退款單號(hào) | out_refund_no | string[1,64] | 返回的退款訂單號(hào)。 示例值:1217752501201407033233368018 |
|
微信支付交易訂單號(hào) | transaction_id | string[1,32] | 是 | 微信支付交易訂單號(hào) 示例值:1217752501201407033233368018 |
商戶原交易訂單號(hào) | out_trade_no | string[1,64] | 是 | 返回的原交易訂單號(hào)。 示例值:1217752501201407033233368018 |
退款渠道 | channel | string[1,16] | 否 | ORIGINAL:原路退款 BALANCE:退回到余額 OTHER_BALANCE:原賬戶異常退到其他余額賬戶 OTHER_BANKCARD:原銀行卡異常退到其他銀行卡 示例值:ORIGINAL |
退款入賬賬戶 | recv_account | string[1,64] | 否 | 取當(dāng)前退款單的退款入賬方 1)退回銀行卡: {銀行名稱}{卡類型}{卡尾號(hào)} 2)退回支付用戶零錢: 支付用戶零錢 3)退回支付用戶零錢通: 支付用戶零錢通 示例值:招商銀行信用卡0403 |
退款資金來(lái)源 | fund_source | string[1,30] | 否 | REFUND_SOURCE_UNSETTLED_FUNDS:未結(jié)算資金退款(默認(rèn)使用未結(jié)算資金退款) REFUND_SOURCE_RECHARGE_FUNDS:可用余額退款 示例值:REFUND_SOURCE_UNSETTLED_FUNDS |
退款成功時(shí)間 | success_time | string[1,64] | 否 | 退款成功時(shí)間,當(dāng)退款狀態(tài)為退款成功時(shí)有返回。 示例值:2018-06-08T10:34:56+08:00 |
退款創(chuàng)建時(shí)間 | create_time? | string[1,64] | 是 | 退款受理時(shí)間 示例值:2018-06-08T10:34:56+08:00 |
退款狀態(tài) | status | string[1,16] | 是 | 退款狀態(tài): SUCCESS:退款成功 REFUNDCLOSE:退款關(guān)閉 PROCESSING:退款處理中 ABNORMAL:退款異常,退款到銀行發(fā)現(xiàn)用戶的卡作廢或者凍結(jié)了,導(dǎo)致原路退款銀行卡失敗,可前往【服務(wù)商平臺(tái)—>交易中心】,手動(dòng)處理此筆退款 示例值:SUCCESS |
退款金額 | amount | object | 是 | 退款金額信息,詳細(xì)說(shuō)明見下文 |
優(yōu)惠退款詳情 | detail | array | 否 | 優(yōu)惠退款信息,詳細(xì)說(shuō)明見下文 |
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | code | string[1, 32] | 是 | 錯(cuò)誤碼,枚舉值見錯(cuò)誤碼列表 示例值:INVALID_REQUEST |
返回信息 | message | string[1, 256] | 是 | 返回信息,如非空,為錯(cuò)誤原因 示例值:參數(shù)格式校驗(yàn)錯(cuò)誤 |
詳細(xì)的錯(cuò)誤描述 | detail | object | 否 | 當(dāng)code為PARAM_ERROR時(shí)返回,詳細(xì)說(shuō)明見下 |
{
"id": "50202002642022072801898085012",
"out_refund_no": "20220724trade003refund001",
"transaction_id": "4200000010202207280683365840",
"out_trade_no": "20220724trade003",
"channel": "ORIGINAL",
"status": "SUCCESS",
"recv_account": "招商銀行借記卡0416",
"fund_source": "REFUND_SOURCE_UNSETTLED_FUNDS",
"success_time": "2022-07-28T15:44:24+08:00",
"create_time": "2022-07-28T15:44:07+08:00",
"amount": {
"refund": 500,
"currency": "CNY",
"payer_refund": 250,
"payer_currency": "CNY",
"settlement_refund": 578,
"settlement_currency": "HKD",
"exchange_rate": {
"type": "SETTLEMENT_RATE",
"rate": 86500000
}
},
"detail": [
{
"promotion_id": "11006096615",
"scope": "GLOBAL",
"type": "COUPON",
"amount": 500,
"refund_amount": 250,
"currency": "CNY"
}
]
}
錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|
SYSTEM_ERROR | 接口返回錯(cuò)誤 | 請(qǐng)嘗試再次掉調(diào)用API。 |
REFUND_NOT_EXIST | 退款訂單查詢失敗 | 請(qǐng)檢查訂單號(hào)是否有誤以及訂單狀態(tài)是否正確,如:未支付、已支付未退款,如果訂單下沒有退款單,則會(huì)返回此錯(cuò)誤碼,其他信息是不返回的 |
BIZERR_NEED_RETRY | 無(wú)效transaction_id | 請(qǐng)求參數(shù)錯(cuò)誤,檢查原交易號(hào)是否存在或發(fā)起支付交易接口返回失敗 |
PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)求參數(shù)錯(cuò)誤,請(qǐng)檢查參數(shù)再調(diào)用退款申請(qǐng) |
APPID_NOT_EXIST | APPID不存在 | 請(qǐng)檢查APPID是否正確 |
MCHID_NOT_EXIST | MchID不存在 | 請(qǐng)檢查MchID是否正確 |
REQUIRE_POST_METHOD | 請(qǐng)使用post方法 | 請(qǐng)檢查請(qǐng)求參數(shù)是否通過(guò)post方法提交 |
SIGN_ERROR | 簽名錯(cuò)誤 | 請(qǐng)檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證