SchoolSet APIPayments

Charge a payment from a wallet

Charges the selected failed or upcoming payment immediately using an active family wallet.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired
Payment identifier.

Request

This endpoint expects a multipart form.
wallet_idintegerRequired
payment_amountdoubleRequired>=0.01
contract_fees_type_idinteger or nullOptional
is_creditboolean or nullOptional
notestring or nullOptional<=255 characters

Response

Payment accepted
statusstringOptional
messagestringOptional
dataobjectOptional
PaymentResource for the new payment.

Errors

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