API Documentation

Automate payment follow-ups from the tools you already use. Connect Google Sheets, Airtable, Stripe, Typeform, and 8,000+ other apps to PayChasers.

Getting Started

1. Generate your API key

Go to Settings in your PayChasers dashboard and scroll to the API Key section. Click Generate API Key. You'll see a key starting with pck_. Copy it immediately. You won't be able to see it again.

2. Authenticate

Every API request needs your key in the Authorization header:

Authorization: Bearer pck_your_key_here

3. Test your connection

curl -H "Authorization: Bearer pck_your_key_here" \
  https://paychasers.com/api/v1/me

Response:

{
  "id": "user_abc123",
  "email": "you@example.com",
  "name": "Your Name",
  "plan": "PRO",
  "currency": "ZAR"
}

API Endpoints

Base URL: https://paychasers.com/api/v1

Clients

List your clients

Create a client

{
  "name": "Acme Corp",
  "email": "billing@acme.com",
  "notes": "Net 30 terms"
}

Chases

List chases (with optional filters)

GET /api/v1/chases
GET /api/v1/chases?status=OVERDUE
GET /api/v1/chases?status=SENT&limit=10

Statuses: SENT, PROMISED, OVERDUE, PAID

Create a chase

{
  "clientEmail": "billing@acme.com",
  "clientName": "Acme Corp",
  "paymentName": "March retainer",
  "amount": 5000,
  "currency": "ZAR",
  "dueDate": "2026-04-15",
  "chaseType": "INVOICE",
  "autoChase": true
}

Required: paymentName, amount, currency, and one of clientId or clientEmail. Optional: clientName, dueDate, chaseType (defaults to INVOICE), autoChase, and deliveryChannel.

When you pass clientEmail, PayChasers finds the existing client or creates a new one automatically. The legacy field name invoiceName is still accepted as an alias for paymentName.

deliveryChannel accepts EMAIL, WHATSAPP, or BOTH. WhatsApp and Both require a Pro+ or Enterprise plan. On any other plan the request still succeeds but the chase falls back to EMAIL.

Chase types: INVOICE, CLIENT_PAYMENT, CONTRACT_MILESTONE, PERSONAL_DEBT, BUSINESS_PAYMENT, SUBSCRIPTION, CUSTOM

Create chases in bulk (Batch upload)

{
  "batchId": "batch_9876",
  "accounts": [
    {
      "clientEmail": "customer1@example.com",
      "clientName": "John Doe",
      "paymentName": "Loan Repayment #44",
      "amount": 250
    },
    {
      "clientEmail": "customer2@example.com",
      "clientName": "Jane Smith",
      "amount": 1050
    }
  ]
}

The bulk endpoint is restricted to the Enterprise plan and is provisioned after a short kickoff call. Requests from Free, Pro, and Pro+ return 403. Push up to 500 accounts per batch, limited to 20 batch requests per hour. The system automatically deduplicates clients based on clientEmail. If you omit batchId, one is generated for you.

Returns 202 Accepted with a per row result:

{
  "success": true,
  "batchId": "batch_9876",
  "processedCount": 2,
  "failedCount": 0,
  "errors": [],
  "warnings": [],
  "chases": [ /* created chases */ ]
}

warnings surfaces cases such as a requested WhatsApp delivery channel that the plan cannot send, which is delivered via email instead.

Mark a chase as paid

Follow-ups

Send a follow-up

{
  "tone": "friendly"
}

Tones: friendly, due_today, overdue, firm
Rate limit: 10 follow-ups per hour.

Webhooks (Enterprise)

Connect PayChasers directly to your CRM or custom database. We fire real-time POST requests to your configured Listener URL whenever critical state changes occur within your account. Configure your URL and HMAC Secret in your dashboard Settings.

Available Events

• chase.paid: Fired immediately when a chase is marked as PAID via the dashboard or API.
• chase.followup_sent: Fired when a follow-up message is sent for a chase.
• chases.bulk_completed: Fired when a bulk batch finishes processing. Payload includes batchId, processedCount, and failedCount.

Cryptographic Validation

To prevent spoofing, every webhook contains an X-PayChasers-Signature HTTP header. This is an HMAC SHA-256 signature generated using your private Webhook Secret and the raw stringified JSON body.

// Example: Express.js signature validation
const crypto = require('crypto');

app.post('/paychasers-webhook', express.json(), (req, res) => {
  const signature = req.headers['x-paychasers-signature'];
  const payload = JSON.stringify(req.body);
  const secret = process.env.PAYCHASERS_WEBHOOK_SECRET;

  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');

  if (signature !== expectedSignature) {
    return res.status(401).send('Invalid signature');
  }

  // Handle the event
  console.log('Received valid event:', req.body.event);
  res.status(200).send('OK');
});

Zapier Integration

Connect PayChasers to 8,000+ apps with Zapier. No code required.

Triggers

These fire automatically when something happens in PayChasers:

Actions

These let other apps create activity in PayChasers:

Real-World Integrations

Plan Limits

Free users get full API access. Chase limits follow your plan. The same limits that apply in the dashboard apply via the API.

Security

• •API keys are hashed with SHA-256 before storage. We never store your raw key.
• •Every request is scoped to your account. You can only access your own clients and chases.
• •Keys can be revoked instantly from Settings. Integrations using a revoked key stop immediately.
• •All API key creation and revocation is logged in the audit trail.
• •Follow-up sending is rate limited to prevent abuse.

Error Handling

All errors return JSON with an error field:

{ "error": "Chase not found" }