Tuitions
List tuitions
List Tuitions
Successful tuition payments are saved, and to access them you can send a GET request to this endpoint.
Endpoint
{{baseurl}}/tuitions
You can add these optional query parameters.
Field | Data Type | Description |
---|---|---|
limit | Number >=1 | This specifies the maximum number of results you want to receive in a single response. It should be a number greater than or equal to 1. |
page | Number >=1 | This indicates which page of results you want to retrieve. Similar to limit, it should also be a number greater than or equal to 1 |
A successful response should look like this.
{
"success": true,
"statusCode": 200,
"message": "Fetched tuition payments",
"data": {
"tuitions": [
{
"id": "a28e5dcc-d6c2-45e6-aeb9-8f87dfa446c1",
"country": "GB",
"university": {
"iban": "123211",
"name": "Payshiga University of London",
"sortCode": "3737378",
"swiftCode": "2928282",
"UCASNumber": "ejhbe873bd83be93y36v",
"accountName": "PLU bank of the GB",
"accountType": "SAVINGS",
"accountNumber": "37383837329"
},
"createdAt": "2024-04-25T22:05:27.181Z",
"updatedAt": "2024-04-25T22:05:30.954Z",
"deletedAt": null,
"type": "SCHOOL",
"currency": "GBP",
"studentId": "e6372fea-5943-479a-a12a-f4b4fdaeb0ab",
"businessId": "0bb1dfc6-a74c-4e53-b41a-4a0c1eab188e",
"reference": "shg_tu_ef89b1ed-9827-4327-bc16-a40580c7b164"
}
],
"meta": {
"size": 1,
"totalItems": 1,
"nextPage": 1,
"previousPage": 0
}
}
}