Get Payment Group by ID

GET /rest/merchants/{MID}/groups/{GroupID}

Description: Returns the payment group identified by GroupID, regardless of whether the group has been processed. Use this endpoint to retrieve current group details, confirm schedule changes, or check post-processing status.

Note: This endpoint returns the group summary only (no embedded payments list). To retrieve payments within the group, use GET /payments.

Path Parameters

MID (required)

Type: string — 8 or 11 digits

Example: 32350000576

GroupID (required)

Type: string (UUID)

Description: The scheduled payment group ID.

Example: 01234567-abcd-1234-9876-abcdef123456

Example Request

GET /rest/merchants/32350000576/groups/01234567-abcd-1234-9876-abcdef123456
Authorization: Bearer <token>

Responses

200 OK

{
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "procarePayId": "32350000576",
  "scheduleDate": "2030-12-24",
  "scheduleHour": 17,
  "locationId": 12,
  "transactionInitiator": "Merchant",
  "surchargeCompliance": false,
  "allowPartial": false,
  "deleted": false,
  "applicationId": 42,
  "paymentCount": 3,
  "totalAmount": 375.00,
  "dateCreated": "2025-06-01T14:30:00Z",
  "lastUpdated": "2025-06-01T14:30:00Z"
}

Error Responses

Status	Meaning
400	Invalid MID or GroupID format.
401	Missing or expired bearer token.
404	Group not found or does not belong to this merchant.
500	Unexpected server error.

Response Fields

Field	Type	Description
`paymentGroupId`	string (UUID)	Unique identifier for the group.
`procarePayId`	string	Procare Pay merchant ID.
`scheduleDate`	string (date)	UTC processing date.
`scheduleHour`	integer (0–23)	UTC processing hour.
`locationId`	integer	Location (school) ID.
`transactionInitiator`	string	`Merchant` or `Consumer`.
`surchargeCompliance`	boolean	Surcharge compliance flag.
`allowPartial`	boolean	Allow partial auth flag.
`deleted`	boolean	Whether the group is soft-deleted.
`applicationId`	integer	Associated application ID, if any.
`paymentCount`	integer	Number of payments in the group.
`totalAmount`	number	Sum of all payment amounts.
`dateCreated`	string (date-time)	UTC creation timestamp.
`lastUpdated`	string (date-time)	UTC last-updated timestamp.