Get Payment Contract Payment | SchoolSet

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

{
  "status": "success",
  "message": "string",
  "data": [
    {
      "id": 1,
      "payer_id": 1,
      "payer_type": "string",
      "can_edit_payer": true,
      "payer": {
        "id": 1,
        "name": "string",
        "donation_receipt_not_allowed": true
      },
      "amount_payment": 1.1,
      "base_amount_payment": 1.1,
      "payment_date": "string",
      "currency": "string",
      "payment_source": "string",
      "merchant_account_id": 1,
      "merchant_account_type_id": 1,
      "credit_type": {},
      "credit_payment": {},
      "note": "string",
      "fee_coverage": 1.1,
      "cc_not_save": true,
      "balance_after_collected_payment": 1.1,
      "status": {
        "id": 1,
        "title": "string",
        "description": "string",
        "group_name": "string"
      },
      "method": {
        "id": 1,
        "title": "string",
        "sysname": "string",
        "description": "string"
      },
      "type": {
        "id": 1,
        "title": "string",
        "sysname": "string",
        "group": "string",
        "type": "string",
        "method": {
          "id": 1,
          "title": "string",
          "sysname": "string",
          "description": "string"
        }
      },
      "wallet": {
        "id": 1,
        "wallet_type": {
          "id": 1,
          "title": "string",
          "description": "string",
          "sys_name": "string",
          "slug": "string"
        },
        "wallet_data": {},
        "wallet_description": "string",
        "merchant_account_type": {
          "id": 1,
          "name": "string",
          "description": "string",
          "sys_name": "string",
          "slug": "string",
          "ach_enabled": true,
          "credit_card_enabled": true
        },
        "merchant_account_customer_info": {},
        "merchant_account_id": 1,
        "active": 1,
        "wallet_status_id": 1,
        "alerts": {},
        "info": {},
        "payer_id": 1,
        "payer_type": "string",
        "priority": "string",
        "removed_on_gateway": true
      },
      "secondary_wallet": {
        "id": 1,
        "wallet_type": {
          "id": 1,
          "title": "string",
          "description": "string",
          "sys_name": "string",
          "slug": "string"
        },
        "wallet_data": {},
        "wallet_description": "string",
        "merchant_account_type": {
          "id": 1,
          "name": "string",
          "description": "string",
          "sys_name": "string",
          "slug": "string",
          "ach_enabled": true,
          "credit_card_enabled": true
        },
        "merchant_account_customer_info": {},
        "merchant_account_id": 1,
        "active": 1,
        "wallet_status_id": 1,
        "alerts": {},
        "info": {},
        "payer_id": 1,
        "payer_type": "string",
        "priority": "string",
        "removed_on_gateway": true
      },
      "allocations": [
        {
          "id": 1,
          "payment_id": 1,
          "model_id": 1,
          "model_type": "string",
          "amount": 1.1,
          "contract_fee_id": 1,
          "pledge_id": 1,
          "contract_fee": {},
          "contract_id": 1,
          "academic_year_id": 1,
          "type": {
            "id": 1,
            "title": "string",
            "sysname": "string",
            "group": "string",
            "type": "string",
            "method": {
              "id": 1,
              "title": "string",
              "sysname": "string",
              "description": "string"
            }
          },
          "fundraising_id": 1,
          "fundraising": {},
          "pledge_fund": {}
        }
      ],
      "allocated_amount": 1.1,
      "unallocated_amount": 1.1,
      "fee_actual": 1.1,
      "family_student_pay": {
        "id": 1,
        "family_student_id": 1,
        "from": "string",
        "to": "string",
        "to_parent": {},
        "contract_id": 1,
        "batch_id": 1,
        "amount_payment": 1.1,
        "payment_status_id": 1,
        "payment_type_id": 1,
        "payment_method_id": 1,
        "payment_date": "string",
        "currency": "string",
        "hash": "string",
        "statement_contract_balance": 1.1,
        "statement_total_due": 1.1,
        "wallet_id": 1,
        "cc_not_save": true,
        "created_by": "string",
        "created_at": "string",
        "updated_at": "string"
      },
      "payment_recurring_id": 1,
      "payment_recurring_status": "string",
      "created_by": "string",
      "payment_settings": {
        "charge_processing_fees": true,
        "fee_display_option": "string",
        "optional_fee_coverage": true
      }
    }
  ]
}

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/history/{contract_id}.

statusstring

messagestring

datalist of objects

1	{
2	"status": "success",
3	"message": "string",
4	"data": [
5	{
6	"id": 1,
7	"payer_id": 1,
8	"payer_type": "string",
9	"can_edit_payer": true,
10	"payer": {
11	"id": 1,
12	"name": "string",
13	"donation_receipt_not_allowed": true
14	},
15	"amount_payment": 1.1,
16	"base_amount_payment": 1.1,
17	"payment_date": "string",
18	"currency": "string",
19	"payment_source": "string",
20	"merchant_account_id": 1,
21	"merchant_account_type_id": 1,
22	"credit_type": {},
23	"credit_payment": {},
24	"note": "string",
25	"fee_coverage": 1.1,
26	"cc_not_save": true,
27	"balance_after_collected_payment": 1.1,
28	"status": {
29	"id": 1,
30	"title": "string",
31	"description": "string",
32	"group_name": "string"
33	},
34	"method": {
35	"id": 1,
36	"title": "string",
37	"sysname": "string",
38	"description": "string"
39	},
40	"type": {
41	"id": 1,
42	"title": "string",
43	"sysname": "string",
44	"group": "string",
45	"type": "string",
46	"method": {
47	"id": 1,
48	"title": "string",
49	"sysname": "string",
50	"description": "string"
51	}
52	},
53	"wallet": {
54	"id": 1,
55	"wallet_type": {
56	"id": 1,
57	"title": "string",
58	"description": "string",
59	"sys_name": "string",
60	"slug": "string"
61	},
62	"wallet_data": {},
63	"wallet_description": "string",
64	"merchant_account_type": {
65	"id": 1,
66	"name": "string",
67	"description": "string",
68	"sys_name": "string",
69	"slug": "string",
70	"ach_enabled": true,
71	"credit_card_enabled": true
72	},
73	"merchant_account_customer_info": {},
74	"merchant_account_id": 1,
75	"active": 1,
76	"wallet_status_id": 1,
77	"alerts": {},
78	"info": {},
79	"payer_id": 1,
80	"payer_type": "string",
81	"priority": "string",
82	"removed_on_gateway": true
83	},
84	"secondary_wallet": {
85	"id": 1,
86	"wallet_type": {
87	"id": 1,
88	"title": "string",
89	"description": "string",
90	"sys_name": "string",
91	"slug": "string"
92	},
93	"wallet_data": {},
94	"wallet_description": "string",
95	"merchant_account_type": {
96	"id": 1,
97	"name": "string",
98	"description": "string",
99	"sys_name": "string",
100	"slug": "string",
101	"ach_enabled": true,
102	"credit_card_enabled": true
103	},
104	"merchant_account_customer_info": {},
105	"merchant_account_id": 1,
106	"active": 1,
107	"wallet_status_id": 1,
108	"alerts": {},
109	"info": {},
110	"payer_id": 1,
111	"payer_type": "string",
112	"priority": "string",
113	"removed_on_gateway": true
114	},
115	"allocations": [
116	{
117	"id": 1,
118	"payment_id": 1,
119	"model_id": 1,
120	"model_type": "string",
121	"amount": 1.1,
122	"contract_fee_id": 1,
123	"pledge_id": 1,
124	"contract_fee": {},
125	"contract_id": 1,
126	"academic_year_id": 1,
127	"type": {
128	"id": 1,
129	"title": "string",
130	"sysname": "string",
131	"group": "string",
132	"type": "string",
133	"method": {
134	"id": 1,
135	"title": "string",
136	"sysname": "string",
137	"description": "string"
138	}
139	},
140	"fundraising_id": 1,
141	"fundraising": {},
142	"pledge_fund": {}
143	}
144	],
145	"allocated_amount": 1.1,
146	"unallocated_amount": 1.1,
147	"fee_actual": 1.1,
148	"family_student_pay": {
149	"id": 1,
150	"family_student_id": 1,
151	"from": "string",
152	"to": "string",
153	"to_parent": {},
154	"contract_id": 1,
155	"batch_id": 1,
156	"amount_payment": 1.1,
157	"payment_status_id": 1,
158	"payment_type_id": 1,
159	"payment_method_id": 1,
160	"payment_date": "string",
161	"currency": "string",
162	"hash": "string",
163	"statement_contract_balance": 1.1,
164	"statement_total_due": 1.1,
165	"wallet_id": 1,
166	"cc_not_save": true,
167	"created_by": "string",
168	"created_at": "string",
169	"updated_at": "string"
170	},
171	"payment_recurring_id": 1,
172	"payment_recurring_status": "string",
173	"created_by": "string",
174	"payment_settings": {
175	"charge_processing_fees": true,
176	"fee_display_option": "string",
177	"optional_fee_coverage": true
178	}
179	}
180	]
181	}