最新更新時間:2020.04.01 版本說明
提交退款申請后,通過調(diào)用該接口查詢退款狀態(tài)。退款有一定延時,用零錢支付的退款20分鐘內(nèi)到賬,銀行卡支付的退款3個工作日后重新查詢退款狀態(tài)。
● 該接口適合原交易發(fā)生多筆部分退款的情況,查詢原交易下所有的退款詳情。
適用對象:直連模式機構(gòu)模式
請求URL:https://api.mch.weixin.qq.com/hk/v3/refunds
請求方式: GET
接口規(guī)則: https://wechatpay-api.gitbook.io/wechatpay-api-v3/wei-xin-zhi-fu-api-v3-jie-kou-gui-fan
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)為URL參數(shù)
body 指該參數(shù)需在請求JSON傳參
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
微信支付訂單號 | transaction_id | string(32) | 二選一 | query 微信支付訂單號 示例值:1217752501201407033233368018 |
商戶訂單號 | out_trade_no | string(32) | query 商戶訂單號 示例值:1217752501201407033233368018 |
|
商戶號 | mchid | string(32) | 是 | query 微信支付分配的商戶號 注意:僅適用于直連模式 示例值:1900000109 |
子商戶號 | sub_mchid | string(32) | 是 | query 微信支付分配的子商戶號 注意:僅適用于機構(gòu)模式 示例值:1900000109 |
機構(gòu)商戶號 | sp_mchid | string(32) | 是 | query 微信支付分配的機構(gòu)商戶號 注意:僅適用于機構(gòu)模式 示例值:1900000100 |
記錄起始位置 | offset | int | 是 | query 分頁功能,起始位置 示例值:0 |
每頁筆數(shù) | count | int | 是 | query 分頁功能,每頁返回記錄數(shù),最大值限制為20 示例值:10 |
使用微信支付訂單號查單示例:
https://api.mch.weixin.qq.com/hk/v3/refunds?transaction_id=1217752501201407033233368018&count=10&offset=0&sp_mchid=1900000100&sub_mchid=1900000109
使用商戶訂單號查單示例:
https://api.mch.weixin.qq.com/hk/v3/refunds?out_trade_no=1217752501201407033233368018&count=10&offset=0&sp_mchid=1900000100&sub_mchid=1900000109
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
微信支付交易訂單號 | id | string(32) | 是 | 微信支付交易訂單號 示例值:1217752501201407033233368018 |
商戶號 | mchid | string(32) | 是 | 微信支付分配的商戶號 注意:僅適用于直連模式 示例值:1900000109 |
子商戶號 | sub_mchid | string(32) | 是 | 微信支付分配的子商戶號 注意:僅適用于機構(gòu)模式 示例值:1900000109 |
機構(gòu)商戶號 | sp_mchid | string(32) | 是 | 微信支付分配的機構(gòu)商戶號 注意:僅適用于機構(gòu)模式 示例值:1900000100 |
商戶原交易訂單號 | out_trade_no | string(64) | 是 | 返回的原交易訂單號。 示例值: 1217752501201407033233368018 |
+ 訂單金額 | amount | object | 是 | 原支付訂單金額信息,詳細說明見下文 |
+ 退款單列表 | data | array | 是 | 返回的退款列表,詳細說明見下文 |
訂單總退款次數(shù) | total_num | int | 是 | 訂單總退款次數(shù) 示例值:0 |
本次返回退款單數(shù) | current_total_num | int | 是 | 本次返回退款單數(shù) 示例值: 10 |
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | code | string(32) | 是 | 錯誤碼,枚舉值見錯誤碼列表 示例值:INVALID_REQUEST |
返回信息 | message | string(256) | 是 | 返回信息,如非空,為錯誤原因 示例值:參數(shù)格式校驗錯誤 |
+ 詳細的錯誤描述 | detail | object | 否 | 當(dāng)code為PARAM_ERROR時返回,詳細說明見下 |
{
"id": "1008450740201411110005820873",
"sp_mchid": "10000100",
"sub_mchid": "20000100",
"out_trade_no": "20150806125346",
"amount" : {
"total": 528800,
"currency":"HKD",
"payer_total": 518799,
"payer_currency": "HKD",
},
"total_num": 1,
"current_total_num": 1,
"data": [
{
"id": "2008450740201411110000174436",
"out_refund_no": "R20150806125346",
"channel": "ORIGINAL",
"amount": {
"refund": 50,
"currency": "CNY",
"payer_refund": 49,
"payer_currency": "HKD",
"exchange_rate" : {
"type": "SETTLEMENT_RATE",
"rate": 8000000
}
},
"status": "SUCCESS",
"recv_account": "招商銀行信用卡0403",
"fund_source": "REFUND_SOURCE_REchARGE_FUNDS",
"success_time": "2018-06-08T10:34:56+08:00",
"create_time": "2018-06-08T10:34:56+08:00",
"detail": [
{
"promotion_id":"109519",
"scope":"GLOBAL",
"type":"COUPON",
"amount": 1,
"refund_amount": 1,
"currency": "HKD"
}
]
}
]
}
錯誤碼 | 描述 | 解決方案 |
---|---|---|
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ù)和方法是否都符合簽名算法要求 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證