Create an accounting deposit batch

POST

https://ssuccessv2.com/app/api/v2/payment/deposit-batches

POST

/app/api/v2/payment/deposit-batches

$ curl -X POST https://ssuccessv2.com/app/api/v2/payment/deposit-batches \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "account_id": 22,
>   "name": "August tuition",
>   "reference": "AUG-2026",
>   "batch_date": {},
>   "note": "Manual deposit",
>   "status": "open",
>   "payment_ids": [
>     5821,
>     5822
>   ]
> }'

1 {
2   "status": "success",
3   "message": "Saved successfully.",
4   "data": {
5     "id": 44,
6     "source": "manual",
7     "status": "open",
8     "account_id": 22,
9     "account_name": "Operating account",
10     "name": "August tuition",
11     "reference": "AUG-2026",
12     "batch_date": {},
13     "is_locked": false,
14     "totals": {
15       "amount": 1250.5,
16       "count": 2
17     },
18     "created_at": {},
19     "updated_at": {}
20   }
21 }

Creates a deposit batch for the active school and may attach payment identifiers during creation.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

account_idinteger or nullOptional

namestring or nullOptional<=255 characters

referencestring or nullOptional<=21 characters

batch_datedate or nullOptional

notestring or nullOptional<=1000 characters

statusenumOptional

Allowed values:

payment_idslist of integersOptional

Response

Deposit batch created successfully.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error