Get Payment Plan Recurring

GET

https://app.schoolset.io/app/api/v1/system/payment/contract/details/payment/plan/recurring/:contract_id

GET

/app/api/v1/system/payment/contract/details/payment/plan/recurring/:contract_id

1 curl https://app.schoolset.io/app/api/v1/system/payment/contract/details/payment/plan/recurring/contract_id \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "status": "success",
3   "message": "string",
4   "data": [
5     {
6       "id": 1,
7       "batch_id": 1,
8       "amount_payment": 1.1,
9       "allocated_amount": 1.1,
10       "unallocated_amount": 1.1,
11       "payment_total_amount": 1.1,
12       "payment_start_date": "string",
13       "currency": "string",
14       "method": {
15         "id": 1,
16         "title": "string",
17         "sysname": "string",
18         "description": "string"
19       },
20       "type": {
21         "id": 1,
22         "title": "string",
23         "sysname": "string",
24         "group": "string",
25         "type": "string",
26         "method": {
27           "id": 1,
28           "title": "string",
29           "sysname": "string",
30           "description": "string"
31         }
32       },
33       "status": {
34         "id": 1,
35         "title": "string",
36         "description": "string",
37         "group_name": "string"
38       },
39       "payments": [
40         {
41           "id": 1,
42           "donor": {},
43           "payer_id": 1,
44           "payer_type": "string",
45           "can_edit_payer": true,
46           "fundraising": {},
47           "batch_id": 1,
48           "amount_payment": 1.1,
49           "base_amount_payment": 1.1,
50           "payment_date": "string",
51           "currency": "string",
52           "method": {
53             "id": 1,
54             "title": "string",
55             "sysname": "string",
56             "description": "string"
57           },
58           "type": {
59             "id": 1,
60             "title": "string",
61             "sysname": "string",
62             "group": "string",
63             "type": "string",
64             "method": {
65               "id": 1,
66               "title": "string",
67               "sysname": "string",
68               "description": "string"
69             }
70           },
71           "payment_type": {
72             "id": 1,
73             "title": "string",
74             "sysname": "string",
75             "group": "string",
76             "type": "string",
77             "method": {
78               "id": 1,
79               "title": "string",
80               "sysname": "string",
81               "description": "string"
82             }
83           },
84           "payment_type_id": 1,
85           "status": {
86             "id": 1,
87             "title": "string",
88             "description": "string",
89             "group_name": "string"
90           },
91           "billing_info": {},
92           "check_date": "string",
93           "payment_source": "string",
94           "paid_recurring_payments": {},
95           "paid_upcoming_payments": {},
96           "paid_recurring_payment": {},
97           "paid_upcoming_payment": {},
98           "replaces_payment": {},
99           "replaced_payments": {},
100           "successful_repeated_payment": {},
101           "balance_after_collected_payment": 1.1,
102           "contract_fees_sorts_global_split": {},
103           "notes": [
104             {
105               "id": 1,
106               "academic_year": {},
107               "type": "string",
108               "type_sysname": "string",
109               "type_slug": "string",
110               "title": "string",
111               "note": "string",
112               "created_by": "string",
113               "attachments": [
114                 {}
115               ],
116               "notes": [
117                 {}
118               ],
119               "created_at": "string",
120               "updated_at": "string"
121             }
122           ],
123           "attachments": [
124             {}
125           ],
126           "emails": {},
127           "sms": {},
128           "voice": {},
129           "fee_actual": 1.1,
130           "fee_fixed": 1.1,
131           "fee_percentage": 1.1,
132           "credit_type": {},
133           "credit_payment": {},
134           "merchant_account_customer_info": {},
135           "merchant_account_id": 1,
136           "merchant_account_type": {
137             "id": 1,
138             "name": "string",
139             "description": "string",
140             "sys_name": "string",
141             "slug": "string",
142             "ach_enabled": true,
143             "credit_card_enabled": true
144           },
145           "contract_id": 1,
146           "replaced_payment_id": 1,
147           "payment_recurring_id": 1,
148           "payment_upcoming_id": 1,
149           "parent_repayment_id": 1,
150           "payment_split_id": 1,
151           "payment_split": {},
152           "contract_fees_type": {},
153           "previous_contract": {},
154           "wallet": {
155             "id": 1,
156             "wallet_type": {
157               "id": 1,
158               "title": "string",
159               "description": "string",
160               "sys_name": "string",
161               "slug": "string"
162             },
163             "wallet_data": {},
164             "wallet_description": "string",
165             "merchant_account_type": {
166               "id": 1,
167               "name": "string",
168               "description": "string",
169               "sys_name": "string",
170               "slug": "string",
171               "ach_enabled": true,
172               "credit_card_enabled": true
173             },
174             "merchant_account_customer_info": {},
175             "merchant_account_id": 1,
176             "active": 1,
177             "wallet_status_id": 1,
178             "alerts": {},
179             "info": {},
180             "payer_id": 1,
181             "payer_type": "string",
182             "priority": "string",
183             "removed_on_gateway": true
184           },
185           "cc_not_save": true,
186           "secondary_wallet": {
187             "id": 1,
188             "wallet_type": {
189               "id": 1,
190               "title": "string",
191               "description": "string",
192               "sys_name": "string",
193               "slug": "string"
194             },
195             "wallet_data": {},
196             "wallet_description": "string",
197             "merchant_account_type": {
198               "id": 1,
199               "name": "string",
200               "description": "string",
201               "sys_name": "string",
202               "slug": "string",
203               "ach_enabled": true,
204               "credit_card_enabled": true
205             },
206             "merchant_account_customer_info": {},
207             "merchant_account_id": 1,
208             "active": 1,
209             "wallet_status_id": 1,
210             "alerts": {},
211             "info": {},
212             "payer_id": 1,
213             "payer_type": "string",
214             "priority": "string",
215             "removed_on_gateway": true
216           },
217           "grace_period": 1,
218           "allocations": [
219             {
220               "id": 1,
221               "payment_id": 1,
222               "model_id": 1,
223               "model_type": "string",
224               "amount": 1.1,
225               "contract_fee_id": 1,
226               "pledge_id": 1,
227               "contract_fee": {},
228               "contract_id": 1,
229               "academic_year_id": 1,
230               "type": {
231                 "id": 1,
232                 "title": "string",
233                 "sysname": "string",
234                 "group": "string",
235                 "type": "string",
236                 "method": {
237                   "id": 1,
238                   "title": "string",
239                   "sysname": "string",
240                   "description": "string"
241                 }
242               },
243               "fundraising_id": 1,
244               "fundraising": {},
245               "pledge_fund": {}
246             }
247           ],
248           "allocated_amount": 1.1,
249           "unallocated_amount": 1.1,
250           "note": "string",
251           "family_student_pay": {
252             "id": 1,
253             "family_student_id": 1,
254             "from": "string",
255             "to": "string",
256             "to_parent": {},
257             "contract_id": 1,
258             "batch_id": 1,
259             "amount_payment": 1.1,
260             "payment_status_id": 1,
261             "payment_type_id": 1,
262             "payment_method_id": 1,
263             "payment_date": "string",
264             "currency": "string",
265             "hash": "string",
266             "statement_contract_balance": 1.1,
267             "statement_total_due": 1.1,
268             "wallet_id": 1,
269             "cc_not_save": true,
270             "created_by": "string",
271             "created_at": "string",
272             "updated_at": "string"
273           },
274           "fee_coverage": 1.1,
275           "payment_settings": {
276             "charge_processing_fees": true,
277             "fee_display_option": "string",
278             "optional_fee_coverage": true
279           }
280         }
281       ],
282       "allocations": [
283         {
284           "id": 1,
285           "payment_id": 1,
286           "model_id": 1,
287           "model_type": "string",
288           "amount": 1.1,
289           "contract_fee_id": 1,
290           "pledge_id": 1,
291           "contract_fee": {},
292           "contract_id": 1,
293           "academic_year_id": 1,
294           "type": {
295             "id": 1,
296             "title": "string",
297             "sysname": "string",
298             "group": "string",
299             "type": "string",
300             "method": {
301               "id": 1,
302               "title": "string",
303               "sysname": "string",
304               "description": "string"
305             }
306           },
307           "fundraising_id": 1,
308           "fundraising": {},
309           "pledge_fund": {}
310         }
311       ],
312       "payment_source": "string",
313       "merchant_account_customer_info": {},
314       "merchant_account_type_id": 1,
315       "merchant_account_id": 1,
316       "payment_split_id": 1,
317       "payment_recurring_period": {},
318       "contract_fees_type": {},
319       "donor": {},
320       "wallet": {
321         "id": 1,
322         "wallet_type": {
323           "id": 1,
324           "title": "string",
325           "description": "string",
326           "sys_name": "string",
327           "slug": "string"
328         },
329         "wallet_data": {},
330         "wallet_description": "string",
331         "merchant_account_type": {
332           "id": 1,
333           "name": "string",
334           "description": "string",
335           "sys_name": "string",
336           "slug": "string",
337           "ach_enabled": true,
338           "credit_card_enabled": true
339         },
340         "merchant_account_customer_info": {},
341         "merchant_account_id": 1,
342         "active": 1,
343         "wallet_status_id": 1,
344         "alerts": {},
345         "info": {},
346         "payer_id": 1,
347         "payer_type": "string",
348         "priority": "string",
349         "removed_on_gateway": true
350       },
351       "secondary_wallet": {
352         "id": 1,
353         "wallet_type": {
354           "id": 1,
355           "title": "string",
356           "description": "string",
357           "sys_name": "string",
358           "slug": "string"
359         },
360         "wallet_data": {},
361         "wallet_description": "string",
362         "merchant_account_type": {
363           "id": 1,
364           "name": "string",
365           "description": "string",
366           "sys_name": "string",
367           "slug": "string",
368           "ach_enabled": true,
369           "credit_card_enabled": true
370         },
371         "merchant_account_customer_info": {},
372         "merchant_account_id": 1,
373         "active": 1,
374         "wallet_status_id": 1,
375         "alerts": {},
376         "info": {},
377         "payer_id": 1,
378         "payer_type": "string",
379         "priority": "string",
380         "removed_on_gateway": true
381       },
382       "grace_period": 1,
383       "payment_method_id": 1,
384       "payment_type_id": 1,
385       "payment_recurring_status_id": 1,
386       "payment_recurring_period_id": 1,
387       "created_by_user_id": 1,
388       "billing_info": {},
389       "last_payment_gen_period": "string",
390       "number_of_repetitions": 1,
391       "contract_fees_type_id": 1,
392       "contract_fees_priority": "string",
393       "contract_fees_sorts": {},
394       "contract_fees_root_payment_id": 1,
395       "contract_fees_sorts_global": {},
396       "payer_id": 1,
397       "payer_type": "string",
398       "payer": {
399         "id": 1,
400         "name": "string"
401       },
402       "wallet_id": 1,
403       "secondary_wallet_id": 1,
404       "note": "string",
405       "credit_type": {},
406       "credit_payment": {},
407       "created_by": "string",
408       "payment_settings": {
409         "charge_processing_fees": true,
410         "fee_display_option": "string",
411         "optional_fee_coverage": true
412       }
413     }
414   ]
415 }

Returns payment information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

contract_idstringRequired

Response

Successful GET response for /api/v1/system/payment/contract/details/payment/plan/recurring/{contract_id}.

statusstring

messagestring

datalist of objects