Add a parent portal payment

Validates and creates an immediate or recurring payment for the signed-in parent’s current contract. The wallet may be an existing wallet or newly supplied ACH/card details.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
payment_amountdoubleRequired
groupenumRequired
Allowed values:
pledge_payment_amountdoubleOptional
payment_datedatetime or nullOptional
payment_recurring_period_idinteger or nullOptional
amount_per_installmentdouble or nullOptional
payment_planlist of maps from strings to anyOptional
wallet_idinteger or nullOptional
secondary_wallet_idinteger or nullOptional
walletmap from strings to anyOptional

Required when wallet_id is absent.

secondary_walletmap from strings to any or nullOptional
payment_method_idinteger or nullOptional
fee_coverageboolean or nullOptional
donation_type_idinteger or nullOptional
messagestring or nullOptional<=1000 characters

Response

Payment or recurring payment created; data is the payment result resource and message is saved for recurring payments.

statusstring
messagestring
datamap from strings to any

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error