Delete Scheduled Payment Group
DELETE
/rest/merchants/{MID}/groups/{GroupID}
Description: Soft-deletes the specified payment group. The group and its payments remain in the system with deleted set to true — they will not be processed at the scheduled time. This operation cannot be undone via the API.
No undo: Once a group is deleted it will not be processed at the scheduled time.
If you need to cancel a scheduled run, this is the correct endpoint. The group record is retained
for audit purposes but will be excluded from all pending-group queries.
Path Parameters
MID (required)
Type: string — 8 or 11 digits
Example:
32350000576GroupID (required)
Type: string (UUID)
Example:
01234567-abcd-1234-9876-abcdef123456Example Request
DELETE /rest/merchants/32350000576/groups/01234567-abcd-1234-9876-abcdef123456 Authorization: Bearer <token>
Responses
200 OK
The group was successfully deleted. The response body is empty.
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. |
Notes
- This is a soft delete — the group record is retained but marked as deleted and excluded from processing.
- Deleted groups still appear in GET /groups with
"deleted": true. - Deleted groups do not appear in GET /merchants/{MID} (pending-only query).