Skip to content
RemindCash

Quickstart

Create an API key, then create and read your first draft receivable in a few minutes.

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.

This guide creates a draft receivable through the API and reads it back. Nothing is sent to your customer.

1. Create an API key

In the app, open Settings → API keys and create a key with the receivables:read and receivables:write scopes.

  • Only company owners and admins can manage keys.
  • Your account needs a verified email and two-factor authentication, and you confirm your password before managing keys.
  • The key is shown once. Copy it to a secret store; RemindCash keeps only a hash.
  • Keys expire after 30 days. See Authentication for rotation.

2. Keep the key out of your code

BASH
export REMINDCASH_API_KEY="<your-api-key>"

3. Create a draft receivable

Every write needs an Idempotency-Key header so a retried request can never create a duplicate.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042",
    "description": "Website redesign"
  }'

The response is 201 Created:

JSON
{
    "data": {
        "id": 1,
        "customer_id": 1,
        "amount_minor": 125000,
        "paid_minor": 0,
        "currency": "USD",
        "due_date": "2026-10-15",
        "status": "draft",
        "external_reference": "INV-1042",
        "description": "Website redesign",
        "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
    }
}

4. Read it back

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

5. Activate in the app

Open the receivable in the app, confirm the customer's contact details and permission, review the reminder schedule and activate it. Activation is not available through the API.

Next: Concepts.