Send a payment link

POST

https://ssuccessv2.com/app/api/v1/family/pay/create/payment/pay

Sends a payment-link notification for a contract, selected contract fees, or a fundraising donor’s pledges. A contract payment link requires contract_id; a pledge link requires both pledge_ids and a donor identifier.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

emailstringRequiredformat: "email"<=255 characters

contract_idinteger or nullOptional

to_parent_student_idinteger or nullOptional

include_previous_years_balanceboolean or nullOptional

previous_years_balance_typeenum or nullOptional

Allowed values:

user_messagestring or nullOptional

contract_fee_idslist of integers or nullOptional

pledge_idslist of integers or nullOptional

fundraising_donor_idinteger or nullOptional

donor_idinteger or nullOptional

Response

Payment-link notification created and queued.

statusstringOptional

messagestringOptional

datalist of anyOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/family/pay/create/payment/pay \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "rachel.cohen@example.com",
>	"contract_id": 9017,
>	"to_parent_student_id": 734,
>	"include_previous_years_balance": true,
>	"previous_years_balance_type": "due_amount",
>	"user_message": "Please review the remaining tuition balance.",
>	"contract_fee_ids": [
>	4201,
>	4202
>	]
>	}'

1	{
2	"status": "success",
3	"message": "Notification created.",
4	"data": []
5	}