Get one deposit batch

GET

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

GET

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

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

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 42,
6     "source": "manual",
7     "status": "open",
8     "account_id": 7,
9     "account_name": "Operating Bank",
10     "merchant_account_id": 3,
11     "merchant_account_name": "SchoolSet Merchant",
12     "external_batch_id": null,
13     "name": "July Tuition Deposit",
14     "reference": "SLIP-0001",
15     "batch_date": {},
16     "settled_at": null,
17     "note": "Daily tuition receipts",
18     "accounting_journal_id": null,
19     "accounting_pushed_at": null,
20     "created_by_user_id": 12,
21     "is_locked": false,
22     "totals": {
23       "amount": 1250.5,
24       "count": 8
25     },
26     "created_at": {},
27     "updated_at": {}
28   }
29 }

Returns the selected school deposit batch with account names, payment totals, lock state, and accounting metadata.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired>=1

Deposit batch identifier.

Response

The deposit batch was returned.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error