Docs

Get PayRetrieve running in under five minutes.

1. Connect Stripe via Restricted API Key

Sign up, open Dashboard Connections, and connect using a Restricted API Key (RAK).

  • Go to Stripe Dashboard → API Keys
  • Click "Create restricted key"
  • Name it "PayRetrieve Audit"
  • Set permissions: Customers: Read, Invoices: Read, Subscriptions: Read
  • Copy the rk_... key and paste it in PayRetrieve

Security note: Connect via Stripe OAuth for secure, read-only access. Never share your secret key.

2. Connect messaging

In the dashboard, add a Resend API key for email, and (optionally) Twilio credentials for SMS and WhatsApp. Email works out of the box with just a Resend key.

3. Configure Webhooks

PayRetrieve provisions the webhook automatically when your Restricted API Key includes Webhook Endpoints: Write. If your key doesn't, add https://payretrieve.online/api/webhooks/stripe to your Stripe Dashboard and subscribe to invoice.payment_failed, invoice.payment_succeeded,invoice.payment_action_required, and customer.subscription.deleted.

Note: Reconnect with a key that has Webhooks: Write to enable automatic provisioning.

4. Recovery Flow

When a payment fails, PayRetrieve sends an Email/SMS/WhatsApp message with a one-click link to Stripe's billing portal. Automatic retries fire at 24h and 72h until the payment recovers.

🔐 Trust & Transparency Features

Permissions Transparency

See exactly what PayRetrieve can and cannot access in your Stripe account. Our dashboard shows:

  • ✓ What we can read (customers, invoices, subscriptions)
  • ✗ What we cannot access (card numbers, bank accounts, charges)
  • Clear permission boundaries with Stripe resource names

Audit Log Visibility

View every Stripe API call PayRetrieve makes in real-time:

  • ✓ Timestamp of each API call
  • ✓ Resource accessed and operation performed
  • ✓ Success/failure status
  • ✓ Complete audit trail for compliance

Immediate Access Revocation

One-click disconnect terminates all access instantly:

  • ✓ Restricted API Key immediately removed from our database
  • ✓ All access to your Stripe account terminated
  • ✓ No further API calls can be made
  • ✓ Audit logs preserved for your records

PayRetrieve uses Stripe OAuth Connect for secure, read-only access. Never share your secret key — use the secure connection flow.

Need help?

Email support@payretrieve.online and we'll get back to you.