SchoolSet APIPayments

Update a payment or recurring payment plan

Updates payment payer, amount, date, method, allocations, or recurring-plan data submitted by the payment editor.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Query parameters

_methodenumRequired
Allowed values:

Request

This endpoint expects an object.
payer_idintegerRequired
payer_typeenumRequired
amount_paymentdoubleOptional
payment_amountdoubleOptional
payment_datedatetimeOptional
payment_type_idintegerOptional
payment_status_idintegerOptional
payment_method_idintegerOptional
groupenumOptional
Allowed values:
notestringOptional
allocationslist of maps from strings to anyOptional
plan_idintegerOptional
payment_planlist of maps from strings to anyOptional
payment_recurring_period_idintegerOptional
of_installmentsintegerOptional
grace_periodintegerOptional
secondary_wallet_idintegerOptional
payment_datamap from strings to anyOptional
wallet_idintegerOptional
credit_type_idintegerOptional
fundraising_fund_idintegerOptional
fundraising_idintegerOptional
fee_coveragebooleanOptional
fee_coverage_apply_tolist of enumsOptional
Allowed values:
send_receiptbooleanOptional

Response

Payment saved.
statusstringOptional
messagestringOptional
datamap from strings to anyOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error