SchoolSet APIPayments

Void or refund an accepted payment

Voids or refunds an eligible gateway payment, optionally preserving a note and refunding its processing fee.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Request

This endpoint expects an object.
notestring or nullOptional
refund_processing_feebooleanOptionalDefaults to false

Response

Payment was voided or refunded.
statusstringOptional
messagestringOptional
datamap from strings to anyOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error