Schedule a split wallet payment

Schedules a future one-time wallet payment and distributes its amount across selected contracts and fee allocations.

Authentication

AuthorizationBearer

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

Request

This endpoint expects a multipart form.
wallet_idintegerRequired
payment_datedatetimeRequired
contracts_idlist of integersRequired
payment_amountslist of doublesRequired
payment_total_amountdoubleRequired>=0.01
contract_fees_types_idlist of integers or nullOptional
notestring or nullOptional<=255 characters

Response

The scheduled wallet split is returned as PaymentResource items in the success envelope.
statusstringOptional
messagestringOptional
datalist of objectsOptional

Errors

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