查詢退款API(支持單品)
應用場景
提交退款申請后,通過調用該接口查詢退款狀態(tài)。退款有一定延時,用零錢支付的退款20分鐘內到賬,銀行卡支付的退款3個工作日后重新查詢退款狀態(tài)。
注意:
1、本接口支持查詢單品優(yōu)惠相關退款信息,且僅支持按微信退款單號或商戶退款單號查詢,若繼續(xù)調用老查詢退款接口,請見http://www.tg885.com/wiki/doc/api/jsapi_sl.php?chapter=9_5
2、請求頻率限制:300qps,即每秒鐘正常的退款查詢請求次數(shù)不超過300次
3、錯誤或無效請求頻率限制:6qps,即每秒鐘異常或錯誤的退款查詢請求不超過6次
接口地址
https://api.mch.weixin.qq.com/pay/refundqueryv2
https://api2.mch.weixin.qq.com/pay/refundqueryv2(備用域名)見跨城冗災方案
是否需要證書
不需要。
請求參數(shù)
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
字段列表見
單品優(yōu)惠僅支持商戶退款單號(out_refund_no)、微信退款單號(refund_id)查單,不支持商戶訂單號、微信訂單號查詢 |
舉例如下:
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
<out_refund_no>123456789</out_refund_no>
<sub_mch_id>1900000109</sub_mch_id>
<sign>66FFB727015F450D167EF38CCC549521</sign>
</xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
<out_refund_no>123456789</out_refund_no>
<sub_mch_id>1900000109</sub_mch_id>
<sign>66FFB727015F450D167EF38CCC549521</sign>
</xml>
返回數(shù)據(jù)
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
返回信息 | return_msg | 否 | String(128) | 簽名失敗 | 返回信息,如非空,為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 |
以下字段在return_code為SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
其他字段列表見
下單時傳了version,返回參數(shù)會有差異,詳情參考:《注意事項》 |
|||||
營銷詳情 | promotion_detail | 否 | String(6000) | 示例見下文 | 營銷詳情列表,使返回值為Json格式 |
單品優(yōu)惠活動promotion_detail字段列表說明:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
券ID | promotion_id | 是 | String(32) | 109519 | 券或者立減優(yōu)惠id |
優(yōu)惠范圍 | scope | 是 | String(32) | SINGLE | GLOBAL- 全場代金券 SINGLE- 單品優(yōu)惠 |
優(yōu)惠類型 | type | 是 | String(32) | DISCOUNT | COUPON- 代金券,需要走結算資金的充值型代金券,(境外商戶券幣種與支付幣種一致) DISCOUNT- 優(yōu)惠券,不走結算資金的免充值型優(yōu)惠券,(境外商戶券幣種與標價幣種一致 |
優(yōu)惠退款金額 | refund_amount | 是 | int | 100 | 代金券退款金額<=退款金額,退款金額-代金券或立減優(yōu)惠退款金額為現(xiàn)金,說明詳見代金券或立減優(yōu)惠 |
商品列表 | goods_detail | 否 | String | 見下文 | 商品信息,使用Json格式 |
商品列表goods_detail字段列表說明:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
商品編碼 | goods_id | 是 | String(32) | 商品編碼 | 由半角的大小寫字母、數(shù)字、中劃線、下劃線中的一種或幾種組成 |
優(yōu)惠退款金額 | refund_amount | 是 | int | 528800 | 優(yōu)惠退款金額 |
商品退貨數(shù)量 | refund_quantity | 是 | int | 1 | 單品的退貨數(shù)量 |
商品單價 | price | 是 | int | 528800 | 單位為:分。如果商戶有優(yōu)惠,需傳輸商戶優(yōu)惠后的單價(例如:用戶對一筆100元的訂單使用了商場發(fā)的優(yōu)惠券100-50,則活動商品的單價應為原單價-50) |
promotion_detail字段值舉例如下:
{
"promotion_detail":[
{
"promotion_id":"109519",
"scope":"SINGLE",
"type":"DISCOUNT",
"refund_amount":5,
"goods_detail":[
{
"goods_id":"a_goods1",
"refund_quantity":7,
"price":1,
"refund_amount":4
},
{
"goods_id":"a_goods2",
"refund_quantity":1,
"price":2,
"refund_amount":1
}
]
}
] }
"promotion_detail":[
{
"promotion_id":"109519",
"scope":"SINGLE",
"type":"DISCOUNT",
"refund_amount":5,
"goods_detail":[
{
"goods_id":"a_goods1",
"refund_quantity":7,
"price":1,
"refund_amount":4
},
{
"goods_id":"a_goods2",
"refund_quantity":1,
"price":2,
"refund_amount":1
}
]
}
] }
返回舉例如下:
<xml>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[TeqClE3i0mvn3DrK]]></nonce_str>
<out_refund_no><![CDATA[1415701182]]></out_refund_no>
<out_trade_no><![CDATA[1415757673]]></out_trade_no>
<refund_fee>3</refund_fee>
<refund_id><![CDATA[2008450740201411110000174436]]></refund_id>
<refund_status><![CDATA[PROCESSING]]></refund_status>
<promotion_detail><![CDATA[{"promotion_detail":[{"promotion_id":"109519","scope":"SINGLE","type":"DISCOUNT","refund_amount":5,"goods_detail":[{"goods_id":"a_goods1","refund_quantity":7,"price":1,"refund_amount":4},{"goods_id":"a_goods2","refund_quantity":1,"price":2,"refund_amount":1}]}]}]]></promotion_detail>
<result_code><![CDATA[SUCCESS]]></result_code>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign>
<refund_recv_accout><![CDATA[1F2841558E233C33ABA71A961D27561C]]></refund_recv_accout>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
<cash_refund_fee><![CDATA[90]]></cash_refund_fee>
</xml>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[TeqClE3i0mvn3DrK]]></nonce_str>
<out_refund_no><![CDATA[1415701182]]></out_refund_no>
<out_trade_no><![CDATA[1415757673]]></out_trade_no>
<refund_fee>3</refund_fee>
<refund_id><![CDATA[2008450740201411110000174436]]></refund_id>
<refund_status><![CDATA[PROCESSING]]></refund_status>
<promotion_detail><![CDATA[{"promotion_detail":[{"promotion_id":"109519","scope":"SINGLE","type":"DISCOUNT","refund_amount":5,"goods_detail":[{"goods_id":"a_goods1","refund_quantity":7,"price":1,"refund_amount":4},{"goods_id":"a_goods2","refund_quantity":1,"price":2,"refund_amount":1}]}]}]]></promotion_detail>
<result_code><![CDATA[SUCCESS]]></result_code>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign>
<refund_recv_accout><![CDATA[1F2841558E233C33ABA71A961D27561C]]></refund_recv_accout>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
<cash_refund_fee><![CDATA[90]]></cash_refund_fee>
</xml>
錯誤碼
名稱 | 描述 | 原因 | 解決方案 |
---|---|---|---|
SYSTEMERROR | 接口返回錯誤 | 系統(tǒng)超時 | 請用相同參數(shù)再次調用API |
REFUNDNOTEXIST | 退款訂單查詢失敗 | 訂單號錯誤或訂單狀態(tài)不正確 | 請檢查訂單號是否有誤以及訂單狀態(tài)是否正確,如:未支付、已支付未退款 |
INVALID_TRANSACTIONID | 無效transaction_id | 請求參數(shù)未按指引進行填寫 | 請求參數(shù)錯誤,檢查原交易號是否存在或發(fā)起支付交易接口返回失敗 |
PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)未按指引進行填寫 | 請求參數(shù)錯誤,請檢查參數(shù)再調用退款申請 |
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ù)格式是否正確 |