List accounting deposit batches

GET

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

GET

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

$ curl https://ssuccessv2.com/app/api/v2/payment/deposit-batches \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 44,
7       "source": "manual",
8       "status": "open",
9       "account_id": 22,
10       "account_name": "Operating account",
11       "merchant_account_id": null,
12       "merchant_account_name": null,
13       "external_batch_id": null,
14       "name": "August tuition",
15       "reference": "AUG-2026",
16       "batch_date": {},
17       "settled_at": null,
18       "note": "Manual deposit",
19       "accounting_journal_id": null,
20       "accounting_pushed_at": null,
21       "created_by_user_id": 18,
22       "is_locked": false,
23       "totals": {
24         "amount": 1250.5,
25         "count": 3
26       },
27       "created_at": {},
28       "updated_at": {}
29     }
30   ]
31 }

Returns deposit batches for the active school, ordered by batch date and identifier with optional accounting filters.

Authentication

AuthorizationBearer

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

Query parameters

sourceenumOptional

Deposit source filter.

Allowed values:

statusenumOptional

Deposit status filter.

Allowed values:

account_idintegerOptional

Accounting account filter.

fromdateOptional

Inclusive batch date lower bound.

todateOptional

Inclusive batch date upper bound.

searchstringOptional

Searches reference name journal identifier or numeric batch identifier.

Response

Deposit batches returned successfully.

statusstringOptional

messagestringOptional

datalist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error