微信自動退款串接基於酷客多小程序商城系統,爲方便財務人員進行訂單退款而開發,將酷客多小程序系統財務退款流程和微信退款系統打通。實現一個系統管理運營。node
1.退款單狀態:待退款、退款中、退款完成、自動退款失敗等web
2.因爲微信申請退款接口接受請求後不會當即進行退款處理,微信此處有延遲,所以在實際業務串接中,不能依據申請退款接口調用是否成功來修改業務系統中退款單的狀態;必須以微信退款通知的狀態或者自行調用查看微信退款狀態接口的狀態爲準算法
微信退款串接流程圖,見下圖json
1.申請退款接口調用須要微信證書;所以須要先到微信商戶平臺——帳戶中心——API安全中下載證書;小程序
此證書是用於調用申請退款接口時使用;須要先安裝到系統中api
2.到微信商戶平臺開啓退款通知配置;並配置退款通知接口地址;此地址用於接受退款結果通知的安全
1.參數錯誤問題,接口要求商戶訂單號、退款單號、退款金額、訂單金額爲業務要求必傳字段;服務器
a)其中商戶訂單號爲你要退的訂單支付時傳入的訂單號微信
b)退款單號爲當前微信商戶號下惟一編號,按照微信官方文檔生成規則便可數據結構
c)指當前訂單屢次退款金額合計不得超過訂單金額
2.申請退款接口調用前;安裝微信API證書,調用時需帶着證書請求
3.接受不到微信退款通知信息問題
a)檢查是否在微信商戶平臺配置開啓退款通知,並配置通知路徑
b)檢查接受通知接口是否正式訪問
c)通知接口必須是部署在服務器,且外網正常訪問得
4.接受微信退款結果通知接口;沒法解密參數問題
微信公佈解密步驟以下:
(1)對加密串A作base64解碼,獲得加密串B
(2)對商戶key作md5,獲得32位小寫key* ( key設置路徑:微信商戶平臺(pay.weixin.qq.com)-->帳戶設置-->API安全-->密鑰設置 )
(3)用key*對加密串B作AES-256-ECB解密(PKCS7Padding)
實際串接時注意
a) 微信通知信息數據格式採用xml;從xml節點中取出加密數據時 ,第一步用base64解碼步驟省略,由於從xml節點取出得數據已經是base64解碼過的字符串了
b)商戶key作md5加密;此處注意商戶key指得再微信商戶平臺配置得32商戶密鑰;md5加密也必定注意是32位小寫;
1.微信官方未提供得代碼; 解密微信退款通知信息方法
/// <summary> /// 解密微信支付退款結果通知 /// </summary> /// <param name="s">要解密字符串</param> /// <param name="shkey">商戶key</param> /// <returns></returns> public static string DecodeReqInfo(string s, string shkey) { string result = null; string key = System.Web.Security.FormsAuthentication.HashPasswordForStoringInConfigFile(shkey, "md5").ToLower(); //32位小寫md5加密 result = DecodeAES256ECB(s, key); return result ; } /// <summary> /// AES-256-ECB字符解密 /// </summary> /// <param name="s">要解密字符串</param> /// <param name="key">密鑰</param> /// <returns></returns> public static string DecodeAES256ECB(string s, string key) { string result = null; try { byte[] keyArray = UTF8Encoding.UTF8.GetBytes(key); byte[] toEncryptArray = Convert.FromBase64String(s); RijndaelManaged rDel = new RijndaelManaged(); rDel.Key = keyArray; rDel.Mode = CipherMode.ECB; rDel.Padding = PaddingMode.PKCS7; ICryptoTransform cTransform = rDel.CreateDecryptor(); byte[] resultArray = cTransform.TransformFinalBlock(toEncryptArray, 0, toEncryptArray.Length); result = UTF8Encoding.UTF8.GetString(resultArray); } catch { } return result ; }
2.微信退款接口串接代碼段, 此代碼是按照微信官方提供demo修改使用;
/// <summary> /// 微信退款接口 /// </summary> /// <param name="transaction_id"></param> /// <param name="out_trade_no">訂單號</param> /// <param name="out_refund_no">退款單號</param> /// <param name="total_fee">總金額</param> /// <param name="refund_fee">退款金額</param> /// <param name="wxPayConfig">微信配置參數類</param> /// <returns></returns> public static string Run(string transaction_id, string out_trade_no, string out_refund_no, string total_fee, string refund_fee, WxPayConfig wxPayConfig) { Log.Info("Refund", "Refund is processing..."); WxPayData data = new WxPayData(); if (!string.IsNullOrEmpty(transaction_id))//微信訂單號存在的條件下,則已微信訂單號爲準 { data.SetValue("transaction_id", transaction_id); } else//微信訂單號不存在,才根據商戶訂單號去退款 { data.SetValue("out_trade_no", out_trade_no); } data.SetValue("total_fee", total_fee);//訂單總金額 data.SetValue("refund_fee", refund_fee);//退款金額 data.SetValue("out_refund_no", out_refund_no);//隨機生成商戶退款單號 data.SetValue("op_user_id", wxPayConfig.MCHID);//操做員,默認爲商戶號 WxPayData result = Refund(data, wxPayConfig);//提交退款申請給API,接收返回數據 Log.Info("Refund", "Refund process complete, result : " + result.ToXml()); return result.ToPrintStr(); } /** * * 申請退款 * @param WxPayData inputObj 提交給申請退款API的參數 * @param int timeOut 超時時間 * @throws WxPayException * @return 成功時返回接口調用結果,其餘拋異常 */ public static WxPayData Refund(WxPayData inputObj,WxPayConfig wxConfig ,int timeOut = 6) { string url = "https://api.mch.weixin.qq.com/secapi/pay/refund"; //檢測必填參數 if (!inputObj.IsSet("out_trade_no") && !inputObj.IsSet("transaction_id")) { throw new WxPayException("退款申請接口中,out_trade_no、transaction_id至少填一個!"); } else if (!inputObj.IsSet("out_refund_no")) { throw new WxPayException("退款申請接口中,缺乏必填參數out_refund_no!"); } else if (!inputObj.IsSet("total_fee")) { throw new WxPayException("退款申請接口中,缺乏必填參數total_fee!"); } else if (!inputObj.IsSet("refund_fee")) { throw new WxPayException("退款申請接口中,缺乏必填參數refund_fee!"); } else if (!inputObj.IsSet("op_user_id")) { throw new WxPayException("退款申請接口中,缺乏必填參數op_user_id!"); } inputObj.SetValue("appid", wxConfig.APPID);//公衆帳號ID inputObj.SetValue("mch_id", wxConfig.MCHID);//商戶號 inputObj.SetValue("nonce_str", Guid.NewGuid().ToString().Replace("-", ""));//隨機字符串 inputObj.SetValue("sign", inputObj.MakeSign(wxConfig));//簽名 string xml = inputObj.ToXml(); var start = DateTime.Now; Log.Debug("WxPayApi", "Refund request : " + xml); string response = HttpService.Post(xml, url, true, timeOut, wxConfig);//調用HTTP通訊接口提交數據到API Log.Debug("WxPayApi", "Refund response : " + response); var end = DateTime.Now; int timeCost = (int)((end - start).TotalMilliseconds);//得到接口耗時 //將xml格式的結果轉換爲對象以返回 WxPayData result = new WxPayData(); result.FromXml(response, wxConfig); //ReportCostTime(url, timeCost, result, wxConfig);//測速上報 return result; } /// <summary> /// 微信支付協議接口數據類,全部的API接口通訊都依賴這個數據結構, /// 在調用接口以前先填充各個字段的值,而後進行接口通訊, /// 這樣設計的好處是可擴展性強,用戶可隨意對協議進行更改而不用從新設計數據結構, /// 還能夠隨意組合出不一樣的協議數據包,不用爲每一個協議設計一個數據包結構 /// </summary> public class WxPayData { public WxPayData() { } //採用排序的Dictionary的好處是方便對數據包進行簽名,不用再簽名以前再作一次排序 private SortedDictionary<string, object> m_values = new SortedDictionary<string, object>(); /** * 設置某個字段的值 * @param key 字段名 * @param value 字段值 */ public void SetValue(string key, object value) { m_values[key] = value; } /** * 根據字段名獲取某個字段的值 * @param key 字段名 * @return key對應的字段值 */ public object GetValue(string key) { object o = null; m_values.TryGetValue(key, out o); return o; } /** * 判斷某個字段是否已設置 * @param key 字段名 * @return 若字段key已被設置,則返回true,不然返回false */ public bool IsSet(string key) { object o = null; m_values.TryGetValue(key, out o); if (null != o) return true; else return false; } /** * @將Dictionary轉成xml * @return 經轉換獲得的xml串 * @throws WxPayException **/ public string ToXml() { //數據爲空時不能轉化爲xml格式 if (0 == m_values.Count) { Log.Error(this.GetType().ToString(), "WxPayData數據爲空!"); throw new WxPayException("WxPayData數據爲空!"); } string xml = "<xml>"; foreach (KeyValuePair<string, object> pair in m_values) { //字段值不能爲null,會影響後續流程 if (pair.Value == null) { Log.Error(this.GetType().ToString(), "WxPayData內部含有值爲null的字段!"); throw new WxPayException("WxPayData內部含有值爲null的字段!"); } if (pair.Value.GetType() == typeof(int)) { xml += "<" + pair.Key + ">" + pair.Value + "</" + pair.Key + ">"; } else if (pair.Value.GetType() == typeof(string)) { xml += "<" + pair.Key + ">" + "<![CDATA[" + pair.Value + "]]></" + pair.Key + ">"; } else//除了string和int類型不能含有其餘數據類型 { Log.Error(this.GetType().ToString(), "WxPayData字段數據類型錯誤!"); throw new WxPayException("WxPayData字段數據類型錯誤!"); } } xml += "</xml>"; return xml; } /** * @將xml轉爲WxPayData對象並返回對象內部的數據 * @param string 待轉換的xml串 * @return 經轉換獲得的Dictionary * @throws WxPayException */ public SortedDictionary<string, object> FromXml(string xml, WxPayConfig wxConfig) { if (string.IsNullOrEmpty(xml)) { Log.Error(this.GetType().ToString(), "將空的xml串轉換爲WxPayData不合法!"); throw new WxPayException("將空的xml串轉換爲WxPayData不合法!"); } XmlDocument xmlDoc = new XmlDocument(); xmlDoc.LoadXml(xml); XmlNode xmlNode = xmlDoc.FirstChild;//獲取到根節點<xml> XmlNodeList nodes = xmlNode.ChildNodes; foreach (XmlNode xn in nodes) { XmlElement xe = (XmlElement)xn; m_values[xe.Name] = xe.InnerText;//獲取xml的鍵值對到WxPayData內部的數據中 } try { //2015-06-29 錯誤是沒有簽名 if(m_values["return_code"] != "SUCCESS") { return m_values; } CheckSign(wxConfig);//驗證簽名,不經過會拋異常 } catch(WxPayException ex) { throw new WxPayException(ex.Message); } return m_values; } /** * @Dictionary格式轉化成url參數格式 * @ return url格式串, 該串不包含sign字段值 */ public string ToUrl() { string buff = ""; foreach (KeyValuePair<string, object> pair in m_values) { if (pair.Value == null) { Log.Error(this.GetType().ToString(), "WxPayData內部含有值爲null的字段!"); throw new WxPayException("WxPayData內部含有值爲null的字段!"); } if (pair.Key != "sign" && pair.Value.ToString() != "") { buff += pair.Key + "=" + pair.Value + "&"; } } buff = buff.Trim('&'); return buff; } /** * @Dictionary格式化成Json * @return json串數據 */ public string ToJson() { string jsonStr = JsonMapper.ToJson(m_values); return jsonStr; } /** * @values格式化成能在Web頁面上顯示的結果(由於web頁面上不能直接輸出xml格式的字符串) */ public string ToPrintStr() { string str = ""; foreach (KeyValuePair<string, object> pair in m_values) { if (pair.Value == null) { Log.Error(this.GetType().ToString(), "WxPayData內部含有值爲null的字段!"); throw new WxPayException("WxPayData內部含有值爲null的字段!"); } str += string.Format("{0}={1}<br>", pair.Key, pair.Value.ToString()); } Log.Debug(this.GetType().ToString(), "Print in Web Page : " + str); return str; } /** * @生成簽名,詳見簽名生成算法 * @return 簽名, sign字段不參加簽名 */ public string MakeSign(WxPayConfig wxConfig) { //轉url格式 string str = ToUrl(); //在string後加入API KEY str += "&key=" + wxConfig.KEY; //MD5加密 var md5 = MD5.Create(); var bs = md5.ComputeHash(Encoding.UTF8.GetBytes(str)); var sb = new StringBuilder(); foreach (byte b in bs) { sb.Append(b.ToString("x2")); } //全部字符轉爲大寫 return sb.ToString().ToUpper(); } /** * * 檢測簽名是否正確 * 正確返回true,錯誤拋異常 */ public bool CheckSign(WxPayConfig wxConfig) { //若是沒有設置簽名,則跳過檢測 if (!IsSet("sign")) { Log.Error(this.GetType().ToString(), "WxPayData簽名存在但不合法!"); throw new WxPayException("WxPayData簽名存在但不合法!"); } //若是設置了簽名可是簽名爲空,則拋異常 else if(GetValue("sign") == null || GetValue("sign").ToString() == "") { Log.Error(this.GetType().ToString(), "WxPayData簽名存在但不合法!"); throw new WxPayException("WxPayData簽名存在但不合法!"); } //獲取接收到的簽名 string return_sign = GetValue("sign").ToString(); //在本地計算新的簽名 string cal_sign = MakeSign(wxConfig); if (cal_sign == return_sign) { return true; } Log.Error(this.GetType().ToString(), "WxPayData簽名驗證錯誤!"); throw new WxPayException("WxPayData簽名驗證錯誤!"); } /** * @獲取Dictionary */ public SortedDictionary<string, object> GetValues() { return m_values; } } /// <summary> /// 微信支付協議接口數據類,全部的API接口通訊都依賴這個數據結構, /// 在調用接口以前先填充各個字段的值,而後進行接口通訊, /// 這樣設計的好處是可擴展性強,用戶可隨意對協議進行更改而不用從新設計數據結構, /// 還能夠隨意組合出不一樣的協議數據包,不用爲每一個協議設計一個數據包結構 /// </summary> public class WxPayData { public WxPayData() { } //採用排序的Dictionary的好處是方便對數據包進行簽名,不用再簽名以前再作一次排序 private SortedDictionary<string, object> m_values = new SortedDictionary<string, object>(); /** * 設置某個字段的值 * @param key 字段名 * @param value 字段值 */ public void SetValue(string key, object value) { m_values[key] = value; } /** * 根據字段名獲取某個字段的值 * @param key 字段名 * @return key對應的字段值 */ public object GetValue(string key) { object o = null; m_values.TryGetValue(key, out o); return o; } /** * 判斷某個字段是否已設置 * @param key 字段名 * @return 若字段key已被設置,則返回true,不然返回false */ public bool IsSet(string key) { object o = null; m_values.TryGetValue(key, out o); if (null != o) return true; else return false; } /** * @將Dictionary轉成xml * @return 經轉換獲得的xml串 * @throws WxPayException **/ public string ToXml() { //數據爲空時不能轉化爲xml格式 if (0 == m_values.Count) { Log.Error(this.GetType().ToString(), "WxPayData數據爲空!"); throw new WxPayException("WxPayData數據爲空!"); } string xml = "<xml>"; foreach (KeyValuePair<string, object> pair in m_values) { //字段值不能爲null,會影響後續流程 if (pair.Value == null) { Log.Error(this.GetType().ToString(), "WxPayData內部含有值爲null的字段!"); throw new WxPayException("WxPayData內部含有值爲null的字段!"); } if (pair.Value.GetType() == typeof(int)) { xml += "<" + pair.Key + ">" + pair.Value + "</" + pair.Key + ">"; } else if (pair.Value.GetType() == typeof(string)) { xml += "<" + pair.Key + ">" + "<![CDATA[" + pair.Value + "]]></" + pair.Key + ">"; } else//除了string和int類型不能含有其餘數據類型 { Log.Error(this.GetType().ToString(), "WxPayData字段數據類型錯誤!"); throw new WxPayException("WxPayData字段數據類型錯誤!"); } } xml += "</xml>"; return xml; } /** * @將xml轉爲WxPayData對象並返回對象內部的數據 * @param string 待轉換的xml串 * @return 經轉換獲得的Dictionary * @throws WxPayException */ public SortedDictionary<string, object> FromXml(string xml, WxPayConfig wxConfig) { if (string.IsNullOrEmpty(xml)) { Log.Error(this.GetType().ToString(), "將空的xml串轉換爲WxPayData不合法!"); throw new WxPayException("將空的xml串轉換爲WxPayData不合法!"); } XmlDocument xmlDoc = new XmlDocument(); xmlDoc.LoadXml(xml); XmlNode xmlNode = xmlDoc.FirstChild;//獲取到根節點<xml> XmlNodeList nodes = xmlNode.ChildNodes; foreach (XmlNode xn in nodes) { XmlElement xe = (XmlElement)xn; m_values[xe.Name] = xe.InnerText;//獲取xml的鍵值對到WxPayData內部的數據中 } try { //2015-06-29 錯誤是沒有簽名 if(m_values["return_code"] != "SUCCESS") { return m_values; } CheckSign(wxConfig);//驗證簽名,不經過會拋異常 } catch(WxPayException ex) { throw new WxPayException(ex.Message); } return m_values; } /** * @Dictionary格式轉化成url參數格式 * @ return url格式串, 該串不包含sign字段值 */ public string ToUrl() { string buff = ""; foreach (KeyValuePair<string, object> pair in m_values) { if (pair.Value == null) { Log.Error(this.GetType().ToString(), "WxPayData內部含有值爲null的字段!"); throw new WxPayException("WxPayData內部含有值爲null的字段!"); } if (pair.Key != "sign" && pair.Value.ToString() != "") { buff += pair.Key + "=" + pair.Value + "&"; } } buff = buff.Trim('&'); return buff; } /** * @Dictionary格式化成Json * @return json串數據 */ public string ToJson() { string jsonStr = JsonMapper.ToJson(m_values); return jsonStr; } /** * @values格式化成能在Web頁面上顯示的結果(由於web頁面上不能直接輸出xml格式的字符串) */ public string ToPrintStr() { string str = ""; foreach (KeyValuePair<string, object> pair in m_values) { if (pair.Value == null) { Log.Error(this.GetType().ToString(), "WxPayData內部含有值爲null的字段!"); throw new WxPayException("WxPayData內部含有值爲null的字段!"); } str += string.Format("{0}={1}<br>", pair.Key, pair.Value.ToString()); } Log.Debug(this.GetType().ToString(), "Print in Web Page : " + str); return str; } /** * @生成簽名,詳見簽名生成算法 * @return 簽名, sign字段不參加簽名 */ public string MakeSign(WxPayConfig wxConfig) { //轉url格式 string str = ToUrl(); //在string後加入API KEY str += "&key=" + wxConfig.KEY; //MD5加密 var md5 = MD5.Create(); var bs = md5.ComputeHash(Encoding.UTF8.GetBytes(str)); var sb = new StringBuilder(); foreach (byte b in bs) { sb.Append(b.ToString("x2")); } //全部字符轉爲大寫 return sb.ToString().ToUpper(); } /** * * 檢測簽名是否正確 * 正確返回true,錯誤拋異常 */ public bool CheckSign(WxPayConfig wxConfig) { //若是沒有設置簽名,則跳過檢測 if (!IsSet("sign")) { Log.Error(this.GetType().ToString(), "WxPayData簽名存在但不合法!"); throw new WxPayException("WxPayData簽名存在但不合法!"); } //若是設置了簽名可是簽名爲空,則拋異常 else if(GetValue("sign") == null || GetValue("sign").ToString() == "") { Log.Error(this.GetType().ToString(), "WxPayData簽名存在但不合法!"); throw new WxPayException("WxPayData簽名存在但不合法!"); } //獲取接收到的簽名 string return_sign = GetValue("sign").ToString(); //在本地計算新的簽名 string cal_sign = MakeSign(wxConfig); if (cal_sign == return_sign) { return true; } Log.Error(this.GetType().ToString(), "WxPayData簽名驗證錯誤!"); throw new WxPayException("WxPayData簽名驗證錯誤!"); } /** * @獲取Dictionary */ public SortedDictionary<string, object> GetValues() { return m_values; } } /*** * 退款查詢完整業務流程邏輯 * @param refund_id 微信退款單號(優先使用) * @param out_refund_no 商戶退款單號 * @param transaction_id 微信訂單號 * @param out_trade_no 商戶訂單號 * @return 退款查詢結果(xml格式) */ public static string Run(string refund_id, string out_refund_no, string transaction_id, string out_trade_no, WxPayConfig wxConfig) { Log.Info("RefundQuery", "RefundQuery is processing..."); WxPayData data = new WxPayData(); if(!string.IsNullOrEmpty(refund_id)) { data.SetValue("refund_id", refund_id);//微信退款單號,優先級最高 } else if(!string.IsNullOrEmpty(out_refund_no)) { data.SetValue("out_refund_no", out_refund_no);//商戶退款單號,優先級第二 } else if(!string.IsNullOrEmpty(transaction_id)) { data.SetValue("transaction_id", transaction_id);//微信訂單號,優先級第三 } else { data.SetValue("out_trade_no", out_trade_no);//商戶訂單號,優先級最低 } WxPayData result = RefundQuery(data, wxConfig);//提交退款查詢給API,接收返回數據 Log.Info("RefundQuery", "RefundQuery process complete, result : " + result.ToXml()); return result.ToPrintStr(); } /** * * 查詢退款 * 提交退款申請後,經過該接口查詢退款狀態。退款有必定延時, * 用零錢支付的退款20分鐘內到帳,銀行卡支付的退款3個工做往後從新查詢退款狀態。 * out_refund_no、out_trade_no、transaction_id、refund_id四個參數必填一個 * @param WxPayData inputObj 提交給查詢退款API的參數 * @param int timeOut 接口超時時間 * @throws WxPayException * @return 成功時返回,其餘拋異常 */ public static WxPayData RefundQuery(WxPayData inputObj,WxPayConfig wxConfig, int timeOut = 6) { string url = "https://api.mch.weixin.qq.com/pay/refundquery"; //檢測必填參數 if(!inputObj.IsSet("out_refund_no") && !inputObj.IsSet("out_trade_no") && !inputObj.IsSet("transaction_id") && !inputObj.IsSet("refund_id")) { throw new WxPayException("退款查詢接口中,out_refund_no、out_trade_no、transaction_id、refund_id四個參數必填一個!"); } inputObj.SetValue("appid", wxConfig.APPID);//公衆帳號ID inputObj.SetValue("mch_id", wxConfig.MCHID);//商戶號 inputObj.SetValue("nonce_str",GenerateNonceStr());//隨機字符串 inputObj.SetValue("sign", inputObj.MakeSign(wxConfig));//簽名 string xml = inputObj.ToXml(); var start = DateTime.Now;//請求開始時間 Log.Debug("WxPayApi", "RefundQuery request : " + xml); string response = HttpService.Post(xml, url, false, timeOut, wxConfig);//調用HTTP通訊接口以提交數據到API Log.Debug("WxPayApi", "RefundQuery response : " + response); var end = DateTime.Now; int timeCost = (int)((end-start).TotalMilliseconds);//得到接口耗時 //將xml格式的結果轉換爲對象以返回 WxPayData result = new WxPayData(); result.FromXml(response, wxConfig); ReportCostTime(url, timeCost, result, wxConfig);//測速上報 return result; }