Create payment link | SchoolSet

Creates a contract or pledge payment link request and sends the payment notification email.

AuthorizationBearer

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

This endpoint expects an object.

contract_iddoubleRequired

contract ID identifier.

emailstringRequired

Must be a valid email address. Must not be greater than 255 characters.

to_parent_student_iddouble or nullOptional

to parent student ID identifier.

include_previous_years_balanceboolean or nullOptional

include previous years balance flag.

previous_years_balance_typeenum or nullOptional

previous years balance type option.

Allowed values:

user_messagestring or nullOptional

user message value.

contract_fee_idslist of integersOptional

contract fee IDs identifier list.

pledge_idslist of integersOptional

pledge IDs list.

fundraising_donor_idinteger or nullOptional

fundraising donor ID identifier.

donor_idinteger or nullOptional

donor ID identifier.

JSON response payload for family payment link creation.

statusenum

Allowed values:

messagestring

datalist of any

1	curl -X POST https://app.schoolset.io/app/api/v1/family/pay/create/payment/pay \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"contract_id": 12345,
6	"email": "parent.johnson@example.com"
7	}'

1	{
2	"status": "success",
3	"message": "Payment link created and notification email sent successfully.",
4	"data": [
5	null
6	]
7	}