Procare Pay Scheduled Payments

Complete API Documentation for Scheduled Payment Processing

Delete Payment

DELETE /rest/merchants/{MID}/groups/{GroupID}/payments/{PaymentID}

Description: Soft-deletes the specified scheduled payment within the group. The payment record is retained with deleted: true and will not be processed at the group's scheduled time.

Transactions alias: Also accessible at DELETE /rest/merchants/{MID}/groups/{GroupID}/transactions/{TransactionID}.

Path Parameters

MID (required)
Type: string — 8 or 11 digits
Example: 32350000576
GroupID (required)
Type: string (UUID)
Example: 01234567-abcd-1234-9876-abcdef123456
PaymentID (required)
Type: string (UUID)
Example: aaaaaaaa-1111-2222-3333-444444444444

Example Request

DELETE /rest/merchants/32350000576/groups/01234567-abcd-1234-9876-abcdef123456/payments/aaaaaaaa-1111-2222-3333-444444444444
Authorization: Bearer <token>

Responses

204 No Content

The payment was successfully deleted. No response body is returned.

Error Responses

StatusMeaning
400Invalid path parameter format.
401Missing or expired bearer token.
404Payment not found or does not belong to this merchant/group.
500Unexpected server error.

Notes

  • This is a soft delete — the payment record is retained with deleted: true.
  • Deleted payments are still returned by GET /payments but will not be processed.
  • To cancel the entire group, use DELETE /groups/{GroupID} instead.