View registration payments by method

GET

https://ssuccessv2.com/app/api/v1/dashboard/employee/financial/payments/methods/:year_id

GET

/app/api/v1/dashboard/employee/financial/payments/methods/:year_id

$ curl https://ssuccessv2.com/app/api/v1/dashboard/employee/financial/payments/methods/2026 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "credit_card": {
6       "payment_total": 18450,
7       "payment_title": "Credit card",
8       "payment_count": 37,
9       "payment_total_rate_percent": 42.18
10     },
11     "check": {
12       "payment_total": 9200,
13       "payment_title": "Check",
14       "payment_count": 18,
15       "payment_total_rate_percent": 21.03
16     },
17     "noPlanYet": {
18       "payment_total": 16090,
19       "payment_title": "No plan yet",
20       "payment_count": 0,
21       "payment_total_rate_percent": 36.79
22     }
23   }
24 }

Returns projected registration payment totals, counts, and percentages for each payment method in an academic year, plus the amount with no plan yet.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

year_idintegerRequired>=1

Academic year or registration batch ID. An empty value is also accepted by the legacy frontend URL for all years.

Response

Payment method statistics wrapped in the standard response envelope.

statusstring

messagestring

datamap from strings to objects

Errors

401

Unauthorized Error

403

Forbidden Error