Show students in the family

GET

https://app.schoolset.io/app/api/v1/family/:id/payments

GET

/app/api/v1/family/:id/payments

1 curl https://app.schoolset.io/app/api/v1/family/id/payments \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Payments retrieved successfully.",
4   "data": [
5     {
6       "id": 1024,
7       "donor": {
8         "name": "John Doe",
9         "email": "john.doe@example.com",
10         "phone": "+1-555-123-4567"
11       },
12       "payer_id": 2048,
13       "payer_type": "parent",
14       "can_edit_payer": false,
15       "fundraising": {
16         "campaign": "Spring Fundraiser 2024",
17         "goal_amount": 5000,
18         "raised_amount": 3200
19       },
20       "batch_id": 305,
21       "amount_payment": 250.75,
22       "base_amount_payment": 250.75,
23       "payment_date": "2024-06-10T15:45:00Z",
24       "currency": "USD",
25       "method": "credit_card",
26       "type": "tuition",
27       "payment_type": "one-time",
28       "payment_type_id": 12,
29       "status": "completed",
30       "billing_info": {
31         "address": "123 Elm Street",
32         "city": "Springfield",
33         "state": "IL",
34         "zip": "62704"
35       },
36       "check_date": null,
37       "payment_source": "online_portal",
38       "paid_recurring_payments": [
39         {
40           "id": 1001,
41           "amount": 100,
42           "date": "2024-05-10T15:45:00Z"
43         }
44       ],
45       "paid_upcoming_payments": [
46         {
47           "id": 1002,
48           "amount": 100,
49           "date": "2024-07-10T15:45:00Z"
50         }
51       ],
52       "paid_recurring_payment": {
53         "id": 1001,
54         "amount": 100,
55         "date": "2024-05-10T15:45:00Z"
56       },
57       "paid_upcoming_payment": {
58         "id": 1002,
59         "amount": 100,
60         "date": "2024-07-10T15:45:00Z"
61       },
62       "replaces_payment": {},
63       "replaced_payments": [],
64       "successful_repeated_payment": {},
65       "balance_after_collected_payment": 1250.25,
66       "contract_fees_sorts_global_split": {
67         "school_fee": 200,
68         "activity_fee": 50
69       },
70       "notes": [
71         "Payment received on time."
72       ],
73       "attachments": [
74         {
75           "filename": "receipt_1024.pdf",
76           "url": "https://app.schoolset.io/receipts/1024.pdf"
77         }
78       ],
79       "emails": [
80         {
81           "to": "john.doe@example.com",
82           "subject": "Payment Confirmation",
83           "sent_at": "2024-06-10T16:00:00Z"
84         }
85       ],
86       "sms": [
87         {
88           "to": "+15551234567",
89           "message": "Your payment of $250.75 has been received.",
90           "sent_at": "2024-06-10T16:05:00Z"
91         }
92       ],
93       "voice": [],
94       "fee_actual": 5.25,
95       "fee_fixed": 2,
96       "fee_percentage": 2.1,
97       "credit_type": {
98         "type": "scholarship",
99         "amount": 100
100       },
101       "credit_payment": {
102         "id": 501,
103         "amount": 100
104       },
105       "merchant_account_customer_info": {
106         "customer_id": "cust_7890",
107         "email": "john.doe@example.com"
108       },
109       "merchant_account_id": 789,
110       "merchant_account_type": {
111         "id": 3,
112         "name": "Stripe",
113         "title": "Stripe Payment Gateway"
114       },
115       "contract_id": 450,
116       "replaced_payment_id": null,
117       "payment_recurring_id": 1001,
118       "payment_upcoming_id": 1002,
119       "parent_repayment_id": null,
120       "payment_split_id": null,
121       "payment_split": {},
122       "contract_fees_type": {
123         "type": "standard"
124       },
125       "previous_contract": {},
126       "wallet": {
127         "id": 301,
128         "wallet_type": {
129           "id": 1,
130           "name": "Primary Wallet",
131           "title": "Main Payment Wallet"
132         },
133         "wallet_data": {
134           "last_four": "4242",
135           "card_type": "Visa"
136         },
137         "wallet_description": "Visa ending in 4242",
138         "merchant_account_type": {
139           "id": 3,
140           "title": "Stripe Payment Gateway"
141         },
142         "merchant_account_customer_info": {
143           "customer_id": "cust_7890"
144         },
145         "merchant_account_id": 789,
146         "active": true,
147         "wallet_status_id": 1,
148         "alerts": {},
149         "info": {
150           "created_at": "2023-01-15T10:00:00Z"
151         },
152         "payer_id": 2048,
153         "payer_type": "parent",
154         "priority": 1,
155         "removed_on_gateway": false
156       },
157       "cc_not_save": false,
158       "secondary_wallet": {
159         "id": 302,
160         "wallet_type": {
161           "id": 2,
162           "name": "Backup Wallet",
163           "title": "Secondary Payment Wallet"
164         },
165         "wallet_data": {
166           "last_four": "1234",
167           "card_type": "MasterCard"
168         },
169         "wallet_description": "MasterCard ending in 1234",
170         "merchant_account_type": {
171           "id": 4,
172           "title": "PayPal"
173         },
174         "merchant_account_customer_info": {
175           "customer_id": "cust_7891"
176         },
177         "merchant_account_id": 790,
178         "active": true,
179         "wallet_status_id": 1,
180         "alerts": {},
181         "info": {
182           "created_at": "2023-06-20T11:30:00Z"
183         },
184         "payer_id": 2048,
185         "payer_type": "parent",
186         "priority": 2,
187         "removed_on_gateway": false
188       },
189       "grace_period": 15,
190       "allocations": [
191         {
192           "allocation_id": 1,
193           "amount": 150,
194           "description": "Tuition Fee"
195         },
196         {
197           "allocation_id": 2,
198           "amount": 100.75,
199           "description": "Activity Fee"
200         }
201       ],
202       "allocated_amount": 250.75,
203       "unallocated_amount": 0,
204       "note": "Payment covers full semester fees.",
205       "family_student_pay": {
206         "student_id": 501,
207         "student_name": "Emily Doe"
208       },
209       "fee_coverage": 5.25,
210       "payment_settings": {
211         "auto_pay": false,
212         "reminder_enabled": true
213       }
214     }
215   ]
216 }

Returns family information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

JSON response payload for family payments.

statusenum

Allowed values:

messagestring

datalist of objects