List a contract payment history

GET

https://ssuccessv2.com/app/api/v1/system/payment/contract/details/payment/history/:contract_id

GET

/app/api/v1/system/payment/contract/details/payment/history/:contract_id

$ curl https://ssuccessv2.com/app/api/v1/system/payment/contract/details/payment/history/1842 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 9012,
7       "payer_id": 417,
8       "payer_type": "family",
9       "can_edit_payer": false,
10       "payer": {
11         "id": 417,
12         "name": "Rivera Family",
13         "processing_fee_blocked": false,
14         "is_processing_fee_blocked": false
15       },
16       "amount_payment": 1250,
17       "base_amount_payment": 1250,
18       "payment_date": {},
19       "currency": "USD",
20       "balance_after_collected_payment": 3750,
21       "status": {
22         "id": 1,
23         "title": "Completed",
24         "description": "Payment completed",
25         "group_name": "completed"
26       },
27       "method": {
28         "id": 2,
29         "title": "Credit card",
30         "sysname": "credit_card",
31         "description": "Card payment"
32       },
33       "type": {
34         "id": 1,
35         "title": "Tuition",
36         "sysname": "tuition",
37         "group": "school",
38         "type": "one_time"
39       },
40       "allocations": [
41         {}
42       ]
43     }
44   ]
45 }

Returns collected and unallocated payments for a SchoolSet contract, including status, payer, payment method, allocations, and the running balance after each payment.

Authentication

AuthorizationBearer

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

Path parameters

contract_idintegerRequired>=1

SchoolSet contract identifier whose payment history should be displayed.

Response

Payment history was loaded for the contract.

statusstring

messagestring

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error