PaymentSystem.Api.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>PaymentSystem.Api</name>
  5. </assembly>
  6. <members>
  7. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.Version">
  8. <summary>
  9. 版本号
  10. </summary>
  11. </member>
  12. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.Encoding">
  13. <summary>
  14. 编码方式
  15. </summary>
  16. </member>
  17. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.SignMethod">
  18. <summary>
  19. 签名方法 SM2
  20. </summary>
  21. </member>
  22. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.MER_ID">
  23. <summary>
  24. 招商银行商户号
  25. </summary>
  26. </member>
  27. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.USER_ID">
  28. <summary>
  29. 招商银行收银员
  30. </summary>
  31. </member>
  32. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.APPID">
  33. <summary>
  34. header中的APPID
  35. </summary>
  36. </member>
  37. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.APP_SECRET">
  38. <summary>
  39. 用于生成header中的APISign
  40. </summary>
  41. </member>
  42. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.SM2_KEY_TITLE">
  43. <summary>
  44. 国密标准公钥头(固定值)
  45. </summary>
  46. </member>
  47. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.SM_USER_ID">
  48. <summary>
  49. 国密局推荐 ID(固定值)
  50. </summary>
  51. </member>
  52. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.SM_PRIVATE_KEY">
  53. <summary>
  54. 国密私钥
  55. </summary>
  56. </member>
  57. <member name="F:PaymentSystem.Api.CMBPayBusiness.BaseConfig.SM_PUBLIC_KEY">
  58. <summary>
  59. 国密公钥 base64
  60. </summary>
  61. </member>
  62. <member name="F:PaymentSystem.Api.CMBPayBusiness.UrlConfig.NotifyUrl">
  63. <summary>
  64. 通知地址
  65. </summary>
  66. </member>
  67. <member name="F:PaymentSystem.Api.CMBPayBusiness.UrlConfig.CollectionQRCode">
  68. <summary>
  69. 收款码申请
  70. </summary>
  71. </member>
  72. <member name="F:PaymentSystem.Api.CMBPayBusiness.UrlConfig.OrderqueryUrl">
  73. <summary>
  74. 支付结果查询
  75. </summary>
  76. </member>
  77. <member name="F:PaymentSystem.Api.CMBPayBusiness.UrlConfig.RefundUrl">
  78. <summary>
  79. 发起退款申请
  80. </summary>
  81. </member>
  82. <member name="F:PaymentSystem.Api.CMBPayBusiness.UrlConfig.RefundqueryUrl">
  83. <summary>
  84. 退款申请查询
  85. </summary>
  86. </member>
  87. <member name="F:PaymentSystem.Api.CMBPayBusiness.UrlConfig.ZFBQRCodeUrl">
  88. <summary>
  89. 支付宝native支付
  90. </summary>
  91. </member>
  92. <member name="M:PaymentSystem.Api.CMBPayBusiness.BusinessLib.api_qrcodeapply(PaymentSystem.Domain.Dtos.OrderDto,System.String)">
  93. <summary>
  94. 收款码申请
  95. </summary>
  96. <param name="dto"></param>
  97. <returns></returns>
  98. </member>
  99. <member name="M:PaymentSystem.Api.CMBPayBusiness.BusinessLib.api_orderquery(PaymentSystem.Domain.Entities.CMBPay.CMBPaymentDetail)">
  100. <summary>
  101. 支付结果查询
  102. </summary>
  103. <param name="entity"></param>
  104. <returns></returns>
  105. </member>
  106. <member name="M:PaymentSystem.Api.CMBPayBusiness.BusinessLib.api_refund(PaymentSystem.Domain.Entities.CMBPay.CMBPaymentDetail,PaymentSystem.Domain.Dtos.CMBPay.CMBRefundReqDto,System.String)">
  107. <summary>
  108. 发起退款申请,需要检查退款币种是否和支付币种一致
  109. </summary>
  110. <param name="detail"></param>
  111. <param name="refund"></param>
  112. <param name="refundNo"></param>
  113. <returns></returns>
  114. </member>
  115. <member name="M:PaymentSystem.Api.CMBPayBusiness.BusinessLib.api_refundquery(PaymentSystem.Domain.Entities.CMBPay.CMBRefundReq)">
  116. <summary>
  117. 退款结果查询
  118. </summary>
  119. <param name="entity"></param>
  120. <returns></returns>
  121. </member>
  122. <member name="M:PaymentSystem.Api.CMBPayBusiness.BusinessLib.api_zfbqrcode(PaymentSystem.Domain.Dtos.OrderDto,System.String)">
  123. <summary>
  124. 创建支付宝收款申请
  125. </summary>
  126. <param name="dto"></param>
  127. <param name="payNo"></param>
  128. <returns></returns>
  129. </member>
  130. <member name="M:PaymentSystem.Api.CMBPayBusiness.Common.GetBeijingTime">
  131. <summary>
  132. 返回网络时间 --北京时间
  133. </summary>
  134. <returns></returns>
  135. </member>
  136. <member name="M:PaymentSystem.Api.CMBPayBusiness.Common.CombinImage(System.Drawing.Image,System.String)">
  137. <summary>
  138. 调用此函数后使此两种图片合并,类似相册,有个
  139. 背景图,中间贴自己的目标图片
  140. </summary>
  141. <param name="imgBack">粘贴的源图片</param>
  142. <param name="destImg">粘贴的目标图片</param>
  143. </member>
  144. <member name="M:PaymentSystem.Api.CMBPayBusiness.Common.KiResizeImage(System.Drawing.Image,System.Int32,System.Int32,System.Int32)">
  145. <summary>
  146. Resize图片
  147. </summary>
  148. <param name="bmp">原始Bitmap</param>
  149. <param name="newW">新的宽度</param>
  150. <param name="newH">新的高度</param>
  151. <param name="Mode">保留着,暂时未用</param>
  152. <returns>处理以后的图片</returns>
  153. </member>
  154. <member name="T:PaymentSystem.Api.CMBPayBusiness.GmUtil">
  155. need lib:
  156. BouncyCastle.Crypto.dll(http://www.bouncycastle.org/csharp/index.html)(这段代码写的时候用的bccrypto-csharp-1.8.8,最低支持版本和最高支持版本自己研究)
  157. log4net.dll(http://logging.apache.org/log4net/)(仅为了输出日志用,不用的话可自行改换其他方式输出异常信息)
  158. ref:
  159. https://tools.ietf.org/html/draft-shen-sm2-ecdsa-02
  160. http://gmssl.org/docs/oid.html
  161. http://www.jonllen.com/jonllen/work/164.aspx
  162. 用BC的注意点:
  163. 这个版本的BC对SM3withSM2的结果为asn1格式的r和s,如果需要直接拼接的r||s需要自己转换。下面rsAsn1ToPlainByteArray、rsPlainByteArrayToAsn1就在干这事。
  164. 这个版本的BC对SM2的结果为C1||C2||C3,据说为旧标准,新标准为C1||C3||C2,用新标准的需要自己转换。下面(被注释掉的)changeC1C2C3ToC1C3C2、changeC1C3C2ToC1C2C3就在干这事。java版的高版本有加上C1C3C2,csharp版没准以后也会加,但目前还没有,java版的目前可以初始化时“ SM2Engine sm2Engine = new SM2Engine(SM2Engine.Mode.C1C3C2);”。
  165. </member>
  166. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.SignSm3WithSm2(System.Byte[],System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  167. @param msg
  168. @param userId
  169. @param privateKey
  170. @return r||s,直接拼接byte数组的rs
  171. </member>
  172. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.signRawToAsn1(System.Byte[])">
  173. 将BC SM2 RAW签名值转化为ASN1格式签名值
  174. @param bcCipTxt
  175. @return
  176. @throws Exception
  177. </member>
  178. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.signAsn12Raw(System.Byte[])">
  179. 将ASN1格式签名值转化为BC SM2 RAW 签名值
  180. @param signature Asn1格式签名值
  181. @return byte[] Raw签名值
  182. </member>
  183. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.SignSm3WithSm2Asn1Rs(System.Byte[],System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  184. @param msg
  185. @param userId
  186. @param privateKey
  187. @return rs in <b>asn1 format</b>
  188. </member>
  189. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.VerifySm3WithSm2(System.Byte[],System.Byte[],System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  190. @param msg
  191. @param userId
  192. @param rs r||s,直接拼接byte数组的rs
  193. @param publicKey
  194. @return
  195. </member>
  196. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.VerifySm3WithSm2Asn1Rs(System.Byte[],System.Byte[],System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  197. @param msg
  198. @param userId
  199. @param rs in <b>asn1 format</b>
  200. @param publicKey
  201. @return
  202. </member>
  203. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.ChangeC1C2C3ToC1C3C2(System.Byte[])">
  204. bc加解密使用旧标c1||c2||c3,此方法在加密后调用,将结果转化为c1||c3||c2
  205. @param c1c2c3
  206. @return
  207. </member>
  208. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.ChangeC1C3C2ToC1C2C3(System.Byte[])">
  209. bc加解密使用旧标c1||c3||c2,此方法在解密前调用,将密文转化为c1||c2||c3再去解密
  210. @param c1c3c2
  211. @return
  212. </member>
  213. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.Sm2Decrypt(System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  214. c1||c3||c2
  215. @param data
  216. @param key
  217. @return
  218. </member>
  219. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.Sm2Encrypt(System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  220. c1||c3||c2
  221. @param data
  222. @param key
  223. @return
  224. </member>
  225. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.Sm2EncryptOld(System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  226. c1||c2||c3
  227. @param data
  228. @param key
  229. @return
  230. </member>
  231. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.Sm2DecryptOld(System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  232. c1||c2||c3
  233. @param data
  234. @param key
  235. @return
  236. </member>
  237. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.Sm3(System.Byte[])">
  238. @param bytes
  239. @return
  240. </member>
  241. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.RsAsn1ToPlainByteArray(System.Byte[])">
  242. BC的SM3withSM2签名得到的结果的rs是asn1格式的,这个方法转化成直接拼接r||s
  243. @param rsDer rs in asn1 format
  244. @return sign result in plain byte array
  245. </member>
  246. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.RsPlainByteArrayToAsn1(System.Byte[])">
  247. BC的SM3withSM2验签需要的rs是asn1格式的,这个方法将直接拼接r||s的字节数组转化成asn1格式
  248. @param sign in plain byte array
  249. @return rs result in asn1 format
  250. </member>
  251. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.Join(System.Byte[][])">
  252. 字节数组拼接
  253. @param params
  254. @return
  255. </member>
  256. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.KDF(System.Byte[],System.Int32)">
  257. 密钥派生函数
  258. @param Z
  259. @param klen
  260. 生成klen字节数长度的密钥
  261. @return
  262. </member>
  263. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.readSm2File(System.Byte[],System.String)">
  264. cfca官网CSP沙箱导出的sm2文件
  265. @param pem 二进制原文
  266. @param pwd 密码
  267. @return
  268. </member>
  269. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.ReadSm2X509Cert(System.Byte[])">
  270. @param cert
  271. @return
  272. </member>
  273. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.parseBase64TRawKey(System.String)">
  274. BASE64格式公钥转换为裸公钥
  275. @param sm2Key
  276. @return
  277. </member>
  278. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.generateSmSign(System.String)">
  279. 加签
  280. </member>
  281. <member name="M:PaymentSystem.Api.CMBPayBusiness.GmUtil.verifySmSign(System.String,System.String)">
  282. 验签
  283. </member>
  284. <member name="T:PaymentSystem.Api.Controllers.AuthController">
  285. <summary>
  286. 鉴权相关
  287. </summary>
  288. </member>
  289. <member name="M:PaymentSystem.Api.Controllers.AuthController.LoginAsync(PaymentSystem.Domain.Dtos.LoginDto)">
  290. <summary>
  291. 用户登录
  292. </summary>
  293. <param name="dto"></param>
  294. <returns></returns>
  295. </member>
  296. <member name="T:PaymentSystem.Api.Controllers.ControllerBase">
  297. <summary>
  298. 控制器基类
  299. </summary>
  300. </member>
  301. <member name="T:PaymentSystem.Api.Controllers.ChatGPTController">
  302. <summary>
  303. CHATGPT
  304. </summary>
  305. </member>
  306. <member name="T:PaymentSystem.Api.Controllers.CMBPayController">
  307. <summary>
  308. 招商银行支付申请
  309. </summary>
  310. </member>
  311. <member name="M:PaymentSystem.Api.Controllers.CMBPayController.CreatePayApply(PaymentSystem.Domain.Dtos.OrderDto)">
  312. <summary>
  313. 创建招行支付申请
  314. </summary>
  315. <param name="dto"></param>
  316. <returns></returns>
  317. </member>
  318. <member name="M:PaymentSystem.Api.Controllers.CMBPayController.SaveData_CMB(System.String,PaymentSystem.Domain.Dtos.OrderDto,PaymentSystem.Domain.CMBPayBusiness.Entity.Result,System.DateTime)">
  319. <summary>
  320. 保存订单数据_招行通用
  321. </summary>
  322. <param name=""></param>
  323. <returns></returns>
  324. </member>
  325. <member name="M:PaymentSystem.Api.Controllers.CMBPayController.CMBPayResultQuery(PaymentSystem.Domain.Dtos.CMBPay.CMBQueryOrderDto)">
  326. <summary>
  327. 招行支付结果查询(只有15天内数据)
  328. </summary>
  329. <param name="orderNo">业务单号</param>
  330. <param name="payNo">招行交易单号</param>
  331. <returns></returns>
  332. </member>
  333. <member name="M:PaymentSystem.Api.Controllers.CMBPayController.CMBRefundRequest(PaymentSystem.Domain.Dtos.CMBPay.CMBRefundReqDto)">
  334. <summary>
  335. 招行退款申请,测试环境下隔日无法退款
  336. </summary>
  337. <param name="orderNo">业务单号</param>
  338. <param name="payNo">招行交易单号</param>
  339. <returns></returns>
  340. </member>
  341. <member name="M:PaymentSystem.Api.Controllers.CMBPayController.CMBRefundResultQuery(PaymentSystem.Domain.Dtos.CMBPay.CMBRefundQueryDto)">
  342. <summary>
  343. 招行退款结果查询(30秒查询一次)
  344. </summary>
  345. <param name="orderNo">业务单号</param>
  346. <param name="payNo">招行交易单号</param>
  347. <returns></returns>
  348. </member>
  349. <member name="T:PaymentSystem.Api.Controllers.NotifyController">
  350. <summary>
  351. 通知地址
  352. </summary>
  353. </member>
  354. <member name="T:PaymentSystem.Api.Controllers.PaymentController">
  355. <summary>
  356. 支付调用
  357. </summary>
  358. </member>
  359. <member name="M:PaymentSystem.Api.Controllers.PaymentController.CreatePayApply(PaymentSystem.Domain.Dtos.OrderDto)">
  360. <summary>
  361. 创建支付申请
  362. </summary>
  363. <param name="dto"></param>
  364. <returns></returns>
  365. </member>
  366. <member name="M:PaymentSystem.Api.Controllers.PaymentController.SaveData_CMB(System.String,PaymentSystem.Domain.Dtos.OrderDto,PaymentSystem.Domain.CMBPayBusiness.Entity.Result,System.DateTime)">
  367. <summary>
  368. 保存订单数据_招行通用
  369. </summary>
  370. <returns></returns>
  371. </member>
  372. <member name="T:PaymentSystem.Api.Controllers.VirtualAccountPayController">
  373. <summary>
  374. 虚拟扣款
  375. </summary>
  376. </member>
  377. <member name="M:PaymentSystem.Api.Controllers.VirtualAccountPayController.CreateCashPrepay(PaymentSystem.Domain.Dtos.CustomerAccount.CashPrepayDto)">
  378. <summary>
  379. 虚拟账户预存
  380. </summary>
  381. <param name="dto"></param>
  382. <returns></returns>
  383. </member>
  384. </members>
  385. </doc>