Procare Pay Scheduled Payments

Complete API Documentation for Scheduled Payment Processing

Trigger Payment Processing for All Groups by Merchant

POST /rest/merchants/{MID}/process-payments
Non-production environments only. This endpoint is disabled in production. The MID must be within the test range 32350000000–32350099999. Requests from production environments or with an out-of-range MID will receive a 403 Forbidden response.

Description: Manually triggers payment processing for all groups belonging to the specified merchant that match the given schedule date and hour. If scheduleDate and scheduleHour are omitted, the system defaults to UTC now + 1 hour. Use this endpoint in development and test environments to validate end-to-end payment flows without waiting for the scheduled time.

Path Parameters

MID (required)
Type: string — must be in range 32350000000–32350099999
Example: 32350000576

Request Body

The request body is optional. Omit it entirely to use the default (UtcNow + 1 hour).

FieldTypeRequiredDescription
scheduleDatestring (date)OptionalDate to target. Format: yyyy-MM-dd. Defaults to current UTC date.
scheduleHourinteger (0–23)OptionalUTC hour to target. Defaults to current UTC hour + 1.

Example Request

POST /rest/merchants/32350000576/process-payments
Authorization: Bearer <token>
Content-Type: application/json

{
  "scheduleDate": "2026-03-15",
  "scheduleHour": 14
}

Responses

200 OK

{
  "triggeredGroups": [
    {
      "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
      "executionArn": "arn:aws:states:us-east-1:123456789012:execution:PaymentStateMachine:run-abc123"
    },
    {
      "paymentGroupId": "76543210-abcd-1234-9876-abcdef123456",
      "executionArn": "arn:aws:states:us-east-1:123456789012:execution:PaymentStateMachine:run-def456"
    }
  ],
  "totalTriggered": 2,
  "totalFailed": 0
}

200 OK — With Partial Failures

{
  "triggeredGroups": [
    {
      "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
      "executionArn": "arn:aws:states:us-east-1:123456789012:execution:PaymentStateMachine:run-abc123"
    },
    {
      "paymentGroupId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "error": "Group not found or already processing."
    }
  ],
  "totalTriggered": 1,
  "totalFailed": 1
}

Error Responses

StatusMeaning
400Invalid MID format or request body validation error.
401Missing or expired bearer token.
403Production environment, or MID is outside the allowed test range.
500Unexpected server error.

Response Fields

FieldTypeDescription
triggeredGroupsarrayOne entry per group that processing was attempted for.
triggeredGroups[].paymentGroupIdstring (UUID)The group that was triggered.
triggeredGroups[].executionArnstringAWS Step Functions execution ARN. Present on success.
triggeredGroups[].errorstringError message for this group. Present on failure.
totalTriggeredintegerNumber of groups successfully triggered.
totalFailedintegerNumber of groups that failed to trigger. Omitted when zero.