Institution recharge interface
<h5>Interface introduction</h5>
<ul>
<li>Third party institution recharge interface with specific Sid and secret account</li>
</ul>
<h5>Interface information</h5>
<table>
<thead>
<tr>
<th style="text-align: left;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">URL</td>
<td style="text-align: left;"><a href="https://neukol.axzt.net/edu_openapi/billing/recharge">https://neukol.axzt.net/edu_openapi/billing/recharge</a></td>
</tr>
<tr>
<td style="text-align: left;">HTTP Request Methods</td>
<td style="text-align: left;">POST</td>
</tr>
<tr>
<td style="text-align: left;">Coding format</td>
<td style="text-align: left;">UTF-8</td>
</tr>
</tbody>
</table>
<h5>Request header</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Field name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
<th style="text-align: left;">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
</tr>
</tbody>
</table>
<h5>Form parameter</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Field name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
<th style="text-align: left;">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">sid</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: left;">Institution ID</td>
<td style="text-align: left;">5f1140092302bd0ac2dbc7c4</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: left;">Fixed 32-bit all lowercase characters, institution authentication security key，sign=MD5(params+SECRET)，Among them, params represents the concatenated string of all parameters in the request body except sign in lexicographic order（like: “key1=value1key2=value2”）</td>
<td style="text-align: left;">c09636a3a529a386fdaa389228e36fac</td>
</tr>
<tr>
<td style="text-align: left;">timestamp</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">True</td>
<td style="text-align: left;">当Unix Epoch timestamp within 20 minutes of current calling interface, unit: milliseconds</td>
<td style="text-align: left;">1600140360000</td>
</tr>
<tr>
<td style="text-align: left;">schoolId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: left;">Sid of recharge institution required</td>
<td style="text-align: left;">45104ea711963e1b595d974a376ec567</td>
</tr>
<tr>
<td style="text-align: left;">amount</td>
<td style="text-align: left;">BigDecimal</td>
<td style="text-align: left;">True</td>
<td style="text-align: left;">Recharge amount, which must be greater than 0</td>
<td style="text-align: left;">100.00</td>
</tr>
<tr>
<td style="text-align: left;">paymentId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: left;">Third party payment of the transaction flow number, in theory should be globally unique, facilitate future data review</td>
<td style="text-align: left;">327212070998881</td>
</tr>
<tr>
<td style="text-align: left;">payType</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Payment channels, such as Alipay, WeChat, etc., mainly used for recharge record display</td>
<td style="text-align: left;">Alipay</td>
</tr>
<tr>
<td style="text-align: left;">remark</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Recharge remarks</td>
<td style="text-align: left;">XXX institution recharge</td>
</tr>
<tr>
<td style="text-align: left;">paymentMarkNo</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Package number</td>
<td style="text-align: left;">1</td>
</tr>
</tbody>
</table>
<h5>Response parameter explanation</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter name</th>
<th style="text-align: left;">Type</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">responseHeader</td>
<td style="text-align: left;">Object</td>
<td>Response header information</td>
</tr>
<tr>
<td style="text-align: left;"> └status</td>
<td style="text-align: left;">int</td>
<td>HTTP corresponding status code</td>
<td>200</td>
</tr>
<tr>
<td style="text-align: left;"> └msg</td>
<td style="text-align: left;">String</td>
<td>Error message</td>
<td>OK</td>
</tr>
<tr>
<td style="text-align: left;">response</td>
<td style="text-align: left;">Object</td>
<td>Response body content</td>
</tr>
<tr>
<td style="text-align: left;"> └accountBalance</td>
<td style="text-align: left;">String</td>
<td>Account balance</td>
<td>"3738.34"</td>
</tr>
<tr>
<td style="text-align: left;"> └cashAmount</td>
<td style="text-align: left;">String</td>
<td>Cash account recharge amount</td>
<td>"100.00"</td>
</tr>
<tr>
<td style="text-align: left;"> └givenAmount</td>
<td style="text-align: left;">String</td>
<td>Account recharge gift amount</td>
<td>"0.00"</td>
</tr>
</tbody>
</table>
<h5>Request example</h5>
<pre><code>POST /edu_openapi/edu_openapi/billing/recharge HTTP/1.1
Host: https://neukol.axzt.net
Content-Type: application/x-www-form-urlencoded
sign=45104ea711963e1b595d974a376ec738&schoolId=45104ea711963e1b595d974a376ec567&amount=100.00&paymentId=199203456678&payType=ALIPAY&paymentMarkNo=1×tamp=1614073825765</code></pre>
<h5>Response example</h5>
<pre><code>{
"responseHeader": {
"status": 200,
"msg": "OK"
},
"response": {
"accountBalance": "3738.34",
"cashAmount": "200.00",
"givenAmount": "0.00"
}
}</code></pre>
<h5>Error code</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Error code</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">9994</td>
<td>Parameter format error</td>
</tr>
<tr>
<td style="text-align: left;">2000</td>
<td>sign certification failed</td>
</tr>
<tr>
<td style="text-align: left;">2001</td>
<td>Request timeout</td>
</tr>
<tr>
<td style="text-align: left;">2002</td>
<td>Institution does not open an open interface</td>
</tr>
<tr>
<td style="text-align: left;">2010</td>
<td>The recharged Institution does not exist</td>
</tr>
<tr>
<td style="text-align: left;">500</td>
<td>unknown exception on the server</td>
</tr>
<tr>
<td style="text-align: left;">2108</td>
<td>Institution recharge failed</td>
</tr>
<tr>
<td style="text-align: left;">2109</td>
<td>Institution has no authority to recharge the wallet or query the balance</td>
</tr>
</tbody>
</table>