Procare Pay Scheduled Payments

Complete API Documentation for Scheduled Payment Processing

Welcome to the Scheduled Payments API

The Procare Pay Scheduled Payments API allows you to schedule payment groups for future processing by merchant ID, date, and hour. Groups contain one or more individual payments that are all processed together at the scheduled time. All date/time values are expressed in UTC.

What Can You Do With This API?

  • Schedule Payment Groups: Create groups of payments that run automatically on a chosen future date and UTC hour.
  • Manage Payments: Add, update, or remove individual payments within a group at any time before processing.
  • Void or Refund: Reverse settled payments at the group or individual payment level.
  • Trigger Processing: Manually kick off payment processing for testing in non-production environments.
  • Email Notifications: Optionally send scheduling notifications and settlement receipts to payors per payment.
All times are UTC. It is the integrator's responsibility to convert merchant local time to UTC when scheduling a group. For example, a payment scheduled for 5:00 PM Eastern (UTC-5) should be submitted with scheduleHour: 22.

Getting Started

🔐

Authentication

All endpoints require a Cognito bearer token. Obtain one using the OAuth2 client credentials flow before making any API calls.

View Auth Guide
⚡

Best Practices

Essential guidance on scheduling workflows, error handling, idempotency, and production readiness for your integration.

View Best Practices
🗂️

Quick Start: Create a Group

Start here to create your first scheduled payment group with one or more payments in a single request.

Create a Group

API Reference

Base Path: All endpoints are relative to your environment's base URL and begin with /rest/merchants/{MID} where {MID} is the 11-digit Procare Pay merchant ID (TEID).

🗂️ Payment Groups

A payment group defines when a set of payments will be processed. It holds the schedule date, hour, merchant ID, and location ID.

💳 Payments

Individual payments live inside a group. Each payment references a saved payment method (profileId) and an amount.

Transactions alias: The /transactions path is functionally identical to /payments. Both paths are supported and route to the same handlers.

↩️ Void / Refund

Reverse settled payments at the group level (all at once) or at the individual payment level.

⚡ Process Payments (Non-Production Only)

Manually trigger payment processing in development and test environments. MID must be in the test range 32350000000–32350099999.

Common Workflows

1. Schedule a New Payment Group

  1. Authenticate and obtain a Cognito bearer token
  2. Create a payment group with scheduleDate, scheduleHour (UTC), locationId, and an initial list of payments
  3. Optionally add more payments to the group before the scheduled time
  4. At the scheduled date/hour, the system automatically processes all payments in the group

2. Update a Scheduled Group Before Processing

  1. List groups to find the target group ID
  2. Update the group to change the schedule date/hour or location
  3. Update individual payments to change amounts or toggle email receipt flags

3. Refund a Settled Group

  1. Get the group to confirm it has been processed
  2. Call void-or-refund on the group — the API will attempt to void or refund each settled payment
  3. Review the results array in the response for per-payment outcomes

Authentication & Security

Cognito Bearer Token Required: Every endpoint requires a valid OAuth2 bearer token in the Authorization header. Tokens are issued by AWS Cognito using the client credentials flow. Required scope: https://scheduled-payments.<env>.procarepay.com/api.execute
MID Authorization: The authenticated client must be authorized for the MID in the URL path. Requests where the token does not cover the supplied MID will receive a 403 Forbidden response.