SchoolSet APIPayments

Add a payment for a payer

Creates or applies a SchoolSet payment using the payer, payment method, allocations, and optional gateway details sent by the payment form.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
payer_idintegerRequired
payer_typeenumRequired
Allowed values:
payment_amountdoubleRequired
payment_method_idintegerRequired
groupenumRequired
Allowed values:
payment_datedatetime or nullOptional
payment_type_idinteger or nullOptional
payment_status_idinteger or nullOptional
notestring or nullOptional
credit_type_idinteger or nullOptional
fundraising_fund_idinteger or nullOptional
fundraising_idinteger or nullOptional
allocationslist of objectsOptional
fee_coverageboolean or nullOptional
fee_coverage_apply_tolist of enumsOptional
Allowed values:
grace_periodinteger or nullOptional
secondary_wallet_idinteger or nullOptional
payment_recurring_period_idinteger or nullOptional
of_installmentsinteger or nullOptional
payment_planlist of objects or nullOptional
payment_datamap from strings to any or nullOptional
wallet_idinteger or nullOptional
payment_idinteger or nullOptional
methodenum or nullOptional
Allowed values:
scheduled_applicationslist of objects or nullOptional
merchant_account_idinteger or nullOptional
card_tokenstring or nullOptional
credit_card_numberdouble or nullOptional
credit_card_exp_datestring or nullOptional
credit_card_cvcinteger or nullOptional
customer_billing_namestring or nullOptional
customer_address_1string or nullOptional
customer_address_2string or nullOptional
customer_citystring or nullOptional
customer_statestring or nullOptional
customer_zipstring or nullOptional
customer_countrystring or nullOptional
customer_phonestring or nullOptional
customer_emailstring or nullOptional
routing_numberstring or nullOptional
account_numberstring or nullOptional
name_on_accountstring or nullOptional
bank_namestring or nullOptional
account_typeenum or nullOptional
Allowed values:

Response

Payment accepted or scheduled
statusstringOptional
messagestringOptional
datamap from strings to anyOptional

Errors

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