Payment information
<h4>Description</h4>
<p>Get Student Payment information</p>
<h4>Request URL</h4>
<p>/api/get-payment-by-id</p>
<h4>Reuqest Method</h4>
<p>POST</p>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Required</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>access_token</td>
<td>true</td>
<td>string</td>
</tr>
<tr>
<td>student_id</td>
<td>false</td>
<td>string</td>
<td>id of the student</td>
</tr>
<tr>
<td>payment_id</td>
<td>false</td>
<td>int</td>
<td>id of the payment</td>
</tr>
<tr>
<td>payment_status</td>
<td>false</td>
<td>int</td>
</tr>
<tr>
<td>charge</td>
<td>false</td>
<td>int</td>
</tr>
</tbody>
</table>
<h4>Response Example</h4>
<pre><code class="language-json">{
"code": 200,
"message": "",
"data": [
{
"id": 123123,
"payment_status": 0,
"charge": 60000,
"student_id": 100000000,
"sfs_fee": [
{
"student_id": 100000000,
"fee_code": 1001,
"charge": 20000,
"due-date": "2022-1-10 12:00:00",
"term_id": 100101,
"create_time": "2022-1-10 12:00:00",
"update_time": "2022-1-10 12:00:00",
"external_id": "123123123",
"description": "xxx"
},
{
"student_id": 100000000,
"fee_code": 1001,
"charge": 40000,
"due-date": "2022-1-10 12:00:00",
"term_id": 100101,
"create_time": "2022-1-10 12:00:00",
"update_time": "2022-1-10 12:00:00",
"external_id": "123123123",
"description": "xxx"
}
]
}
]
}
</code></pre>
<h4>Response Parameter Description</h4>
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>int</td>
<td>Id for payment, used for bank matching process</td>
</tr>
<tr>
<td>payment_status</td>
<td>int</td>
<td>Payment status 0 for processing, processing means bank has response for success operation but not been matching for bank transaction files. status 1 for payment which successfully matching during the matching process. -1 for invalid payment which is overpay or underpaid, which will be generated after the admin click “reject”(驳回), -2 for payment which is fail due to system error or internet connection error or other errors.</td>
</tr>
<tr>
<td>charge</td>
<td>int</td>
</tr>
<tr>
<td>student_id</td>
<td>int</td>
</tr>
<tr>
<td>sfs_fee</td>
<td>list of object</td>
<td>Fees related to the payment, a payment can involved many fees</td>
</tr>
<tr>
<td>student-id</td>
<td>int</td>
</tr>
<tr>
<td>fee_code</td>
<td>int</td>
<td>Code representing fee type</td>
</tr>
<tr>
<td>charge</td>
<td>int</td>
</tr>
<tr>
<td>due-date</td>
<td>string</td>
</tr>
<tr>
<td>term_id</td>
<td>int</td>
<td>Id of fee term</td>
</tr>
<tr>
<td>create_time</td>
<td>string</td>
</tr>
<tr>
<td>update_time</td>
<td>string</td>
</tr>
<tr>
<td>external_id</td>
<td>string</td>
<td>Payment from outside system contains many information, an id will be able to let user retrieve those information later.</td>
</tr>
<tr>
<td>description</td>
<td>string</td>
</tr>
</tbody>
</table>