Documentation — Retriev

Quickstart

Retriev connects to your Stripe account and automatically monitors for failed payments. When a payment fails, we trigger a smart recovery sequence optimized for each customer.

Setup steps

Create your Retriev account
Connect your Stripe account via OAuth
Configure webhook endpoint in Stripe dashboard
Customize your dunning email templates (optional)

Most customers see their first recovered payment within 48 hours of connecting.

Connect Stripe

Use Stripe Connect to authorize Retriev to monitor your payment events. We request read-write access to:

Read payment intents and invoices
Create retry attempts for failed payments
Receive webhooks for payment events

We never store your Stripe secret key. OAuth tokens are encrypted and stored securely.

Webhook setup

Add a webhook endpoint in your Stripe dashboard to notify Retriev of payment events.

Endpoint URL

https://retriev-api.garytuohy.workers.dev/api/webhook

Required events

payment_intent.payment_failed
invoice.payment_failed
invoice.paid
customer.subscription.deleted
checkout.session.completed

Copy the signing secret from Stripe and add it to your Retriev settings to enable webhook verification.

Dunning sequences

Retriev uses multi-email sequences to recover failed payments. Each sequence is personalized based on customer history and payment patterns.

Default sequence

Day 1: Soft reminder
Day 3: Retry notification
Day 7: Urgency reminder
Day 14: Final attempt

API authentication

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer YOUR_TOKEN

Get your token from the Retriev dashboard after logging in.

API endpoints

GET /api/dashboard/stats

Returns recovery metrics for the authenticated account.

{
  "recovered_month": 12450,
  "recovery_rate": 0.73,
  "active_sequences": 24,
  "total_recovered": 47200
}

GET /api/dashboard/payments

Returns a list of recent failed payments and their recovery status.

GET /api/dashboard/sequences

Returns active dunning sequences with progress metrics.