https://api.vauchflow.com
Include your secret API key in every request:
Authorization: Bearer vf_sk_YOUR_KEY
| Method | Path | Description |
|---|
POST | /v1/vouchers | Create a single voucher |
POST | /v1/vouchers/bulk | Generate up to 50,000 codes (async) |
GET | /v1/vouchers/{code} | Look up a voucher |
POST | /v1/vouchers/{code}/validate | Check eligibility — no redemption consumed |
POST | /v1/vouchers/{code}/redeem | Atomically redeem |
POST | /v1/vouchers/{code}/rollback | Reverse a redemption within 30 minutes |
PATCH | /v1/vouchers/{code} | Update metadata or expiry |
GET | /v1/vouchers | Paginated list with filters |
| Method | Path | Description |
|---|
POST | /v1/campaigns | Create a campaign with rules |
GET | /v1/campaigns | List campaigns |
GET | /v1/campaigns/{id} | Campaign detail + pool stats |
PATCH | /v1/campaigns/{id} | Update name, end date, budget cap |
POST | /v1/campaigns/{id}/pause | Pause or resume |
| Method | Path | Description |
|---|
POST | /v1/customers | Register a customer reference (no PII required) |
GET | /v1/customers/{id}/redemptions | Full redemption history |
DELETE | /v1/customers/{id} | GDPR right to erasure |
GET | /v1/customers/{id}/export | GDPR data portability (JSON or CSV) |
| Method | Path | Description |
|---|
GET | /v1/analytics/overview | Tenant-level summary |
GET | /v1/analytics/campaigns/{id} | Per-campaign metrics + time series |
GET | /v1/analytics/fraud | Velocity anomalies and fraud alerts |
GET | /v1/reports/redemptions | Export full redemption log as CSV |
| Code | Meaning |
|---|
200 | Success |
201 | Created |
202 | Accepted (async job started) |
204 | No content |
400 | Invalid request |
401 | Authentication failed |
404 | Resource not found |
409 | Already redeemed / duplicate |
422 | Idempotency key mismatch |
429 | Rate limit exceeded — check Retry-After header |