Get Pending Groups for Merchant

GET /rest/merchants/{MID}

Description: Returns all payment groups for the specified merchant that have not yet been processed (pending groups only). Use this endpoint as a quick dashboard query to see what is scheduled and outstanding.

Pending only: This endpoint returns groups that have not yet been processed. To retrieve all groups regardless of processing status, use GET /rest/merchants/{MID}/groups.

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. When supplied (with `pageSize`), the response is wrapped in a paged envelope.
`pageSize`	integer ≥ 1	Optional	Number of items per page.

Responses

200 OK — Unpaged (default)

When pageNumber / pageSize are not supplied, returns a plain JSON array.

[
  {
    "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": 3,
    "totalAmount": 375.00,
    "dateCreated": "2025-06-01T14:30:00Z",
    "lastUpdated": "2025-06-01T14:30:00Z"
  }
]

200 OK — Paged

When pageNumber and pageSize are supplied, returns a paginated envelope.

{
  "meta": {
    "page": 1,
    "pageSize": 10,
    "totalItems": 23,
    "totalPages": 3
  },
  "items": [
    {
      "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
      "procarePayId": "32350000576",
      "scheduleDate": "2030-12-24",
      "scheduleHour": 17,
      "locationId": 12,
      "deleted": false,
      "paymentCount": 3,
      "totalAmount": 375.00
    }
  ]
}

Error Responses

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

Response Fields

Field	Type	Description
`paymentGroupId`	string (UUID)	Unique identifier for the payment group.
`procarePayId`	string	Procare Pay merchant ID associated with this group.
`scheduleDate`	string (date)	ISO 8601 UTC date when payments will be processed.
`scheduleHour`	integer (0–23)	UTC hour at which processing will run on `scheduleDate`.
`locationId`	integer	Location (school) ID associated with the group.
`transactionInitiator`	string	`Merchant` or `Consumer`.
`surchargeCompliance`	boolean	Whether surcharge compliance rules are enforced.
`allowPartial`	boolean	Whether partial authorizations are accepted.
`deleted`	boolean	Whether the group is soft-deleted.
`paymentCount`	integer	Number of payments in this group.
`totalAmount`	number	Sum of all payment amounts in this group.
`dateCreated`	string (date-time)	UTC timestamp of group creation.
`lastUpdated`	string (date-time)	UTC timestamp of last update.

Notes

Only groups with deleted: false and not yet processed are returned by this endpoint.
To see all groups including processed ones, use GET /groups.
Combine date and time filters to narrow results to a specific processing window.