Pass your API key via theDocumentation Index
Fetch the complete documentation index at: https://docs.revtain.com/llms.txt
Use this file to discover all available pages before exploring further.
X-API-KEY header on all requests:
Onboarding Credentials
During onboarding, you receive two credentials:| Credential | Format | Purpose |
|---|---|---|
| API Key | rev_xxxxxxxxxxxxxxxxxxxxxxxx | Authenticates all API requests |
| Webhook Signing Secret | whsec_xxxxxxxxxxxxxxxxxxxxxxxx | Verifies inbound webhook signatures |
Both are shown once during onboarding. Store them in environment variables — never in client-side code or repositories.
What You Provide
- Your payment gateway key (Stripe secret key, Braintree credentials, etc.)
- A webhook URL (HTTPS endpoint to receive recovery notifications)
- Optionally, up to 2 backup gateways for multi-gateway cascade
Optional Configuration
| Field | Type | Default | Description |
|---|---|---|---|
billingCycleDay | integer (1-31) | Friday payday window | Day of month customers are billed. Optimises retry timing. |
timezone | string | UTC | IANA timezone (e.g., America/New_York). |
dunningEnabled | boolean | false | Enable automated dunning webhook sequences on failure. |
cardUpdateDomain | string | — | Custom domain for branded card update page (e.g., pay.yourdomain.com). |
Rate Limits
| Endpoint | Limit |
|---|---|
/api/recovery/execute | 60 requests / minute / API key |
/api/recovery/tokenize | 10 requests / minute / API key |
| All others | No specific limit (fair-use applies) |
429 Too Many Requests with a retryAfter field.