Changelog

Notable changes to the EzPays Public API.

We use calendar versioning for changelog entries while the URL prefix stays at /v1. Backwards-incompatible changes are reserved for a future /v2.

2026-05-05 — 1.0.0 General Availability

Initial public release.

Resources

• payment-links — full CRUD + cancel/regenerate/qr.
• cases, cases/:id/payments, cases/:id/actions/:action — recovery cases and lifecycle actions (pause, resume, settle, cancel).
• imports — bulk debt import (up to 1,000 rows per call).

Cross-cutting

• Bearer-token auth with ezp_live_* / ezp_test_* keys.
• Per-endpoint scopes: payments:read|write, recovery:read|write|import.
• Idempotency-Key header on all POST endpoints (24-hour replay window).
• Cursor-based pagination on every list endpoint.
• Per-key rate limits with X-RateLimit-* and Retry-After headers.
• Structured { error: { code, message, request_id, details? } } envelope.

Webhooks

• 10 event types covering payment-link and recovery lifecycles.
• HMAC-SHA256 signed deliveries (EzPays-Signature: t=...,v1=...).
• Configurable retry policy: 6 attempts over ~30 hours.