Update Scheduled Payment Group

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

Description: Updates the mutable fields of the specified payment group. This is a full replacement (PUT) — provide all required fields, not just the fields being changed.

Full replacement: This is a PUT operation — all required fields must be included in the request body. Fields omitted from the body will be cleared to their default values. Read the current group state first using GET /groups/{GroupID} before issuing a PUT.

Path Parameters

MID (required)

Type: string — 8 or 11 digits

Example: 32350000576

GroupID (required)

Type: string (UUID)

Example: 01234567-abcd-1234-9876-abcdef123456

Request Body

Field	Type	Required	Description
`paymentGroupId`	string (UUID)	Required	Must match `GroupID` in the path.
`procarePayId`	string	Required	Procare Pay merchant ID.
`scheduleDate`	string (date)	Required	UTC processing date. Format: `yyyy-MM-dd`.
`scheduleHour`	integer (0–23)	Required	UTC processing hour.
`locationId`	integer	Required	Location (school) ID.
`transactionInitiator`	string	Optional	`Merchant` (default) or `Consumer`.
`surchargeCompliance`	boolean	Optional	Enforce surcharge compliance. Default: `false`.
`allowPartial`	boolean	Optional	Allow partial authorizations.

Example Request

PUT /rest/merchants/32350000576/groups/01234567-abcd-1234-9876-abcdef123456
Authorization: Bearer <token>
Content-Type: application/json

{
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "procarePayId": "32350000576",
  "scheduleDate": "2030-12-25",
  "scheduleHour": 15,
  "locationId": 10,
  "transactionInitiator": "Merchant",
  "surchargeCompliance": false
}

Responses

200 OK

{
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "procarePayId": "32350000576",
  "scheduleDate": "2030-12-25",
  "scheduleHour": 15,
  "locationId": 10,
  "transactionInitiator": "Merchant",
  "surchargeCompliance": false,
  "deleted": false,
  "paymentCount": 3,
  "totalAmount": 375.00,
  "dateCreated": "2025-06-01T14:30:00Z",
  "lastUpdated": "2025-06-02T09:00:00Z"
}

Error Responses

Status	Meaning
400	Validation error — missing required fields or invalid values.
401	Missing or expired bearer token.
404	Group not found or does not belong to this merchant.
500	Unexpected server error.