Api.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>运营商接口文档</title>
  6. <link rel="stylesheet" href="https://www.layuicdn.com/layui-v2.5.5/css/layui.css" media="all">
  7. </head>
  8. <style>
  9. p {
  10. font-size: 25px;
  11. }
  12. </style>
  13. <body>
  14. <fieldset class="layui-elem-field layui-field-title" style="margin-top: 20px;">
  15. <legend style="font-size: 40px;">1.请求规范</legend>
  16. <p>1.1 发送请求</p>
  17. <p>发送Http请求用POST</p>
  18. <p>测试商户: s_id=1607066747476332018 key=V6Qv8zQel9RBvE9lIa7NYYqGCe5eCdbPPuRByE7rrQLdBC9RMKfWLbGbb3IsSOFI</p>
  19. <p>加签规则:金额+回调地址+订单号+手机号码+商户编号+key 进行MD5 加密(UTF8 编码)32位转大写---(amount+notify_url+order_no+phone+s_id+key).toUpperCase()</p>
  20. <p>请求地址:&nbsp;&nbsp;&nbsp;http://系统方提供的ip/Order/Api/invest</p>
  21. </fieldset>
  22. <fieldset class="layui-elem-field layui-field-title" style="margin-top: 20px;">
  23. <legend>请求数据</legend>
  24. </fieldset>
  25. <div class="layui-form">
  26. <table class="layui-table">
  27. <colgroup>
  28. <col width="150">
  29. <col width="150">
  30. <col width="200">
  31. <col>
  32. </colgroup>
  33. <thead>
  34. <tr>
  35. <th>名称</th>
  36. <th>类型</th>
  37. <th>必须</th>
  38. <th>备注</th>
  39. </tr>
  40. </thead>
  41. <tbody>
  42. <tr>
  43. <td>phone</td>
  44. <td>String</td>
  45. <td>是</td>
  46. <td>充值手机号</td>
  47. </tr>
  48. <tr>
  49. <td>order_no</td>
  50. <td>String</td>
  51. <td>是</td>
  52. <td>运营商提供的订单号</td>
  53. </tr>
  54. <tr>
  55. <td>s_id</td>
  56. <td>String</td>
  57. <td>是</td>
  58. <td>系统提供的商户编号</td>
  59. </tr>
  60. <tr>
  61. <td>amount</td>
  62. <td>String</td>
  63. <td>是</td>
  64. <td>金额,正整数,以元为单位</td>
  65. </tr>
  66. <tr>
  67. <td>notify_url</td>
  68. <td>String</td>
  69. <td>是</td>
  70. <td>充值结果回调地址 </td>
  71. </tr>
  72. <tr>
  73. <td>timeout</td>
  74. <td>String</td>
  75. <td>否</td>
  76. <td>时间戳:1609810477(不参与加签) </td>
  77. </tr>
  78. <tr>
  79. <td>sign</td>
  80. <td>String</td>
  81. <td>是</td>
  82. <td>签名</td>
  83. </tr>
  84. </tbody>
  85. </table>
  86. <p> 1.2同步返回参数 Map</p>
  87. <table class="layui-table">
  88. <colgroup>
  89. <col width="150">
  90. <col width="150">
  91. <col width="200">
  92. <col>
  93. </colgroup>
  94. <thead>
  95. <tr>
  96. <th>名称</th>
  97. <th>类型</th>
  98. <th>必须</th>
  99. <th>备注</th>
  100. </tr>
  101. </thead>
  102. <tbody>
  103. <tr>
  104. <td>result</td>
  105. <td>String</td>
  106. <td>是</td>
  107. <td>下单状态返回码-SUCCESS:受理成功 fail:受理失败</td>
  108. </tr>
  109. <tr>
  110. <td>msg</td>
  111. <td>String</td>
  112. <td>是</td>
  113. <td>状态码说明(见3.msg编码说明)</td>
  114. </tr>
  115. <tr>
  116. <td>merchantOrderNo</td>
  117. <td>String</td>
  118. <td>是</td>
  119. <td>运营商订单号</td>
  120. </tr>
  121. <tr>
  122. <td>orderNo</td>
  123. <td>String</td>
  124. <td>否</td>
  125. <td>系统订单号</td>
  126. </tr>
  127. </table>
  128. <p>1.3 根据回调地址异步返回通知结果参数</p>
  129. <table class="layui-table">
  130. <colgroup>
  131. <col width="150">
  132. <col width="150">
  133. <col width="200">
  134. <col>
  135. </colgroup>
  136. <thead>
  137. <tr>
  138. <th>名称</th>
  139. <th>类型</th>
  140. <th>必须</th>
  141. <th>备注</th>
  142. </tr>
  143. </thead>
  144. <tbody>
  145. <tr>
  146. <td>result</td>
  147. <td>String</td>
  148. <td>是</td>
  149. <td>充值状态--success:充值成功小写fail:充值失败</td>
  150. </tr>
  151. <tr>
  152. <td>msg</td>
  153. <td>String</td>
  154. <td>是</td>
  155. <td>状态码说明(见3.msg编码说明)</td>
  156. </tr>
  157. <tr>
  158. <td>order</td>
  159. <td>String</td>
  160. <td>否</td>
  161. <td>联通电信官方订单号,充值失败为空</td>
  162. </tr>
  163. <tr>
  164. <td>phone_no</td>
  165. <td>String</td>
  166. <td>是</td>
  167. <td>充值手机号</td>
  168. </tr>
  169. <tr>
  170. <td>amount</td>
  171. <td>String</td>
  172. <td>是</td>
  173. <td>充值金额 </td>
  174. </tr>
  175. <tr>
  176. <td>op_no</td>
  177. <td>String</td>
  178. <td>是</td>
  179. <td>运营商订单号</td>
  180. </tr>
  181. <tr>
  182. <td>sign</td>
  183. <td>String</td>
  184. <td>是</td>
  185. <td>签名方式 result+msg+order_no+phone_no+amount+op_no+key 进行 MD5 方式(UTF8 编码)</td>
  186. </tr>
  187. </tbody>
  188. </table>
  189. </div>
  190. <fieldset class="layui-elem-field layui-field-title" style="margin-top: 20px;">
  191. <legend style="font-size: 40px;">2.充值状态查询接口</legend>
  192. <p>1.1 发送请求</p>
  193. <p>发送Http请求用POST</p>
  194. <p>加签规则:orderId+sid+key 进行 MD5 方式大写(UTF8 编码)</p>
  195. <p>请求地址:&nbsp;&nbsp;&nbsp;http://系统方提供的ip/Order/Api/queryStatus</p>
  196. <p>请求参数:</p>
  197. </fieldset>
  198. <div class="layui-form">
  199. <table class="layui-table">
  200. <colgroup>
  201. <col width="150">
  202. <col width="150">
  203. <col width="200">
  204. <col>
  205. </colgroup>
  206. <thead>
  207. <tr>
  208. <th>名称</th>
  209. <th>类型</th>
  210. <th>必须</th>
  211. <th>备注</th>
  212. </tr>
  213. </thead>
  214. <tbody>
  215. <tr>
  216. <td>sid</td>
  217. <td>String</td>
  218. <td>是</td>
  219. <td>商户编码</td>
  220. </tr>
  221. <tr>
  222. <td>orderId</td>
  223. <td>String</td>
  224. <td>是</td>
  225. <td>运营商订单号</td>
  226. </tr>
  227. <tr>
  228. <td>sign</td>
  229. <td>String</td>
  230. <td>是</td>
  231. <td>签名方式:orderId+sid+key 进行 MD5 方式大写(UTF8 编码)</td>
  232. </tr>
  233. </tbody>
  234. </table>
  235. <p>同步返回参数:</p>
  236. <table class="layui-table">
  237. <colgroup>
  238. <col width="150">
  239. <col width="150">
  240. <col width="200">
  241. <col>
  242. </colgroup>
  243. <thead>
  244. <tr>
  245. <th>名称</th>
  246. <th>类型</th>
  247. <th>必须</th>
  248. <th>备注</th>
  249. </tr>
  250. </thead>
  251. <tbody>
  252. <tr>
  253. <td>result</td>
  254. <td>String</td>
  255. <td>是</td>
  256. <td>请求状态码</td>
  257. </tr>
  258. <tr>
  259. <td>msg</td>
  260. <td>String</td>
  261. <td>是</td>
  262. <td>状态码说明(见3.msg编码说明)</td>
  263. </tr>
  264. <tr>
  265. <td>data</td>
  266. <td>Map</td>
  267. <td>否</td>
  268. <td>返回的订单数据</td>
  269. </tr>
  270. </tbody>
  271. </table>
  272. <p>充值状态查询接口返回data订单数据:</p>
  273. <table class="layui-table">
  274. <colgroup>
  275. <col width="150">
  276. <col width="150">
  277. <col width="200">
  278. <col>
  279. </colgroup>
  280. <thead>
  281. <tr>
  282. <th>名称</th>
  283. <th>类型</th>
  284. <th>必须</th>
  285. <th>备注</th>
  286. </tr>
  287. </thead>
  288. <tbody>
  289. <tr>
  290. <td>orderNo</td>
  291. <td>String</td>
  292. <td>是</td>
  293. <td>商户订单号</td>
  294. </tr>
  295. <tr>
  296. <td>phone</td>
  297. <td>String</td>
  298. <td>是</td>
  299. <td>手机号</td>
  300. </tr>
  301. <tr>
  302. <td>mobileOrderId</td>
  303. <td>String</td>
  304. <td>否</td>
  305. <td>网厅单号</td>
  306. </tr>
  307. <tr>
  308. <td>amount</td>
  309. <td>String</td>
  310. <td>是</td>
  311. <td>金额</td>
  312. </tr>
  313. <tr>
  314. <td>status</td>
  315. <td>String</td>
  316. <td>是</td>
  317. <td>订单状态</td>
  318. </tr>
  319. </tbody>
  320. </table>
  321. </div>
  322. <fieldset class="layui-elem-field layui-field-title" style="margin-top: 20px;">
  323. <legend style="font-size: 40px;">3.msg编码说明</legend>
  324. </fieldset>
  325. <div class="layui-form">
  326. <table class="layui-table">
  327. <colgroup>
  328. <col width="150">
  329. <col>
  330. </colgroup>
  331. <thead>
  332. <tr>
  333. <th>编码</th>
  334. <th>说明</th>
  335. </tr>
  336. </thead>
  337. <tbody>
  338. <tr>
  339. <td>0</td>
  340. <td>充值失败</td>
  341. </tr>
  342. <tr>
  343. <td>1</td>
  344. <td>充值成功</td>
  345. </tr>
  346. <tr>
  347. <td>2</td>
  348. <td>充值中</td>
  349. </tr>
  350. <tr>
  351. <td>3</td>
  352. <td>匹配失败</td>
  353. </tr>
  354. <tr>
  355. <td>-1</td>
  356. <td>商户不存在</td>
  357. </tr>
  358. <tr>
  359. <td>-2</td>
  360. <td>此订单已被列入黑名单</td>
  361. </tr>
  362. <tr>
  363. <td>-3</td>
  364. <td>下单超时</td>
  365. </tr>
  366. <tr>
  367. <td>-4</td>
  368. <td>上传参数不能为空</td>
  369. </tr>
  370. <tr>
  371. <td>-5</td>
  372. <td>订单号不可重复</td>
  373. </tr>
  374. <tr>
  375. <td>-6</td>
  376. <td>加密参数不匹配,请检查是否加签成功</td>
  377. </tr>
  378. <tr>
  379. <td>-7</td>
  380. <td>商户余额不足</td>
  381. </tr>
  382. <tr>
  383. <td>-8</td>
  384. <td>订单不存在(按照失败订单处理)</td>
  385. </tr>
  386. <tr>
  387. <td>-9</td>
  388. <td>移动运营商通道已关闭</td>
  389. </tr>
  390. <tr>
  391. <td>-10</td>
  392. <td>联通运营商通道已关闭</td>
  393. </tr>
  394. <tr>
  395. <td>-11</td>
  396. <td>电信运营商通道已关闭</td>
  397. </tr>
  398. <tr>
  399. <td>-99</td>
  400. <td>数据处理异常,请稍后再试</td>
  401. </tr>
  402. </tbody>
  403. </table>
  404. </div>
  405. </body>
  406. </html>