Get All Scheduled Payment Groups

GET /rest/merchants/{MID}/groups

Description: Returns all scheduled payment groups for the specified merchant, regardless of processing status. This includes pending, processed, and deleted groups.

Pending groups only? If you only need groups that have not yet been processed, use GET /rest/merchants/{MID} instead.

Path Parameters

MID (required)

Type: string

Pattern: \d{8}(\d{3})? — 8 or 11 digits

Description: The 11-digit Procare Pay merchant ID (TEID).

Example: 32350000576

Query Parameters

Parameter	Type	Required	Description
`date`	string (date)	Optional	Filter to groups scheduled on this date. Format: `yyyy-MM-dd`.
`time`	integer (0–23)	Optional	Filter to groups scheduled at this UTC hour.
`locationID`	integer	Optional	Filter to groups associated with this location (school) ID.
`pageNumber`	integer ≥ 1	Optional	1-based page number for paginated results.
`pageSize`	integer ≥ 1	Optional	Number of items per page.

Example Request

GET /rest/merchants/32350000576/groups?date=2030-12-24&locationID=12
Authorization: Bearer <token>

Responses

200 OK — Unpaged

[
  {
    "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
    "procarePayId": "32350000576",
    "scheduleDate": "2030-12-24",
    "scheduleHour": 17,
    "locationId": 12,
    "transactionInitiator": "Merchant",
    "surchargeCompliance": false,
    "allowPartial": false,
    "deleted": false,
    "paymentCount": 2,
    "totalAmount": 250.00,
    "dateCreated": "2025-06-01T14:30:00Z",
    "lastUpdated": "2025-06-01T14:30:00Z"
  },
  {
    "paymentGroupId": "76543210-abcd-1234-9876-abcdef123456",
    "procarePayId": "32350000576",
    "scheduleDate": "2030-12-25",
    "scheduleHour": 15,
    "locationId": 10,
    "deleted": false,
    "paymentCount": 1,
    "totalAmount": 99.99
  }
]

200 OK — Paged

{
  "meta": {
    "page": 1,
    "pageSize": 10,
    "totalItems": 42,
    "totalPages": 5
  },
  "items": [ ... ]
}

Error Responses

Status	Meaning
400	Invalid MID format or query parameter.
401	Missing or expired bearer token.
500	Unexpected server error.

Notes

Results include groups at all stages: pending, processing, processed, and deleted.
Use date and locationID filters together for the most targeted queries.
For large merchants, always use pagination to avoid oversized response payloads.