Skip to content
RemindCash

Reminders

How reminder schedules work and how to read the reminder attempts made for a receivable.

Public API status

The v1 API described here is implemented and tested, but api.remindcash.com is not yet open to the public. It opens after final acceptance testing; until then requests return 503. Examples use placeholders — never paste a real key into shared code.

How reminders are scheduled

Each active receivable follows the company's reminder schedule. The default sends 3 days before, on and 3 days after the due date; companies can add, remove or move steps in the app. Reminders are sent inside the company's allowed hours (by default 09:00–18:00 local time, weekends off) and move to the next allowed time instead of being sent twice.

Reminders stop when a receivable is paid, paused, disputed or cancelled, and when the customer opts out.

List reminder attempts

GET /v1/reminder-attempts returns the delivery attempts for one receivable, newest first. It requires the receivables:read scope.

Query parameter Required Description
receivable_id Yes The receivable to inspect.
per_page No 1–100, default 25.
BASH
curl "https://api.remindcash.com/v1/reminder-attempts?receivable_id=1" \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"
JSON
{
    "data": [],
    "meta": { "current_page": 1, "per_page": 25, "total": 0 },
    "request_id": "8cfc4494-5a40-4bd9-aa9b-5d5716840140"
}

The attempt object

Field Description
id Attempt ID.
attempt_no Attempt number for that reminder step.
stage_key Which step of the schedule this attempt belongs to.
channel Message channel, for example email.
provider_state Internal dispatch state: prepared, claimed, sending, accepted, rejected, unknown or cancelled.
delivery_status Normalised email status: queued, sending, accepted, delivered, bounced, failed, unknown or cancelled. null when not available.
submitted_at When the message was handed to the provider (UTC), or null.
resolved_at When the outcome became final (UTC), or null.

Reading delivery statuses honestly

  • accepted means the provider accepted the message — not that it was delivered or read.
  • delivered is shown only when the provider reports delivery.
  • unknown means the provider did not answer clearly (for example a timeout). RemindCash does not retry automatically in that case, to avoid sending twice; the attempt stays unknown until it is reconciled.
  • A delivered reminder never marks a receivable as paid.