Get All statuses

GET

https://app.schoolset.io/app/api/v1/system/payment/statuses/all

GET

/app/api/v1/system/payment/statuses/all

1 curl https://app.schoolset.io/app/api/v1/system/payment/statuses/all \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Payment statuses retrieved successfully.",
4   "data": [
5     {
6       "id": "paid",
7       "description": "Payment has been completed successfully.",
8       "code": 1,
9       "active": true
10     },
11     {
12       "id": "pending",
13       "description": "Payment is pending and awaiting confirmation.",
14       "code": 2,
15       "active": true
16     },
17     {
18       "id": "failed",
19       "description": "Payment attempt failed due to an error.",
20       "code": 3,
21       "active": false
22     },
23     {
24       "id": "refunded",
25       "description": "Payment has been refunded to the payer.",
26       "code": 4,
27       "active": false
28     }
29   ]
30 }

Lists payment records for the active school context.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Response

Successful GET response for /api/v1/system/payment/statuses/all.

statusstring

messagestring

datalist of maps from strings to any