Remove payments from a batch

Detaches the submitted payment identifiers from a mutable deposit batch and reports how many payments were removed.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired>=1
Deposit batch identifier.

Request

This endpoint expects an object.
payment_idslist of integersRequired

Response

Payments were detached and the removal count was returned.
statusstringOptional
messagestringOptional
dataobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error