/v2/loyalties. It manages modular loyalty programs: Reusable components (card definitions, earning rules, rewards, benefits, and tier structures), program assignments, members and their cards, dry-run examine calls, and aggregated reports.
This is the entry point into the API reference. For product concepts and the Loyalty hub, see Loyalty program overview. For an integration-oriented map of the member journey, see Loyalty v2 developer overview.
/v1/loyalties remains in maintenance mode. For new integrations, use Loyalty v2. See Legacy loyalty API.
How resources connect
Loyalty v2 separates configuration from runtime membership:- Components are created independently under their own paths (
/card-definitions,/earning-rules,/rewards,/benefits,/tier-structures). - A program (
/programs) is the container that assigns those components into one customer-facing setup. Activation requires at least one active card definition (point wallet in the dashboard) and one active earning rule. - Members enroll under a program. Voucherify issues one loyalty card per active card definition assigned to that program.
- Examine endpoints estimate earnings and reward availability without writing balances.
- Reports return aggregated program and member statistics for dashboards and analytics.
API groups
Programs
Create and manage programs, and assign wallets, earning rules, tiers, and rewards.
Members
Enroll members, read memberships, adjust points, list transactions, pay with points, and purchase rewards.
Examine
Dry-run earning and reward evaluation for member portals and checkout previews.
Card definitions
Configure point wallets: pending points, expiration, limits, and pay-with-points exchange.
Earning rules
Define triggers and earnings for orders, custom events, and segment entry.
Rewards
Build the reward catalog members can purchase with points.
Benefits
Define automatic material or digital grants from earning rules.
Tier structures
Configure tier levels and read tier progress on memberships.
Reports
Read aggregated spending, earnings, tier movements, and earning-rule statistics.
Core objects and identifiers
Loyalty v2 uses program-scoped resources. Store these IDs in your system and pass the correct type on each call.Shared platform APIs
Loyalty v2 does not replace the rest of the Voucherify API. Runtime flows still use:- Authentication and regional base URLs from API overview
- Customers before membership
- Orders with
status: PAIDfor order-paid earning rules and pay with points - Custom events for event-based earning rules
- Discount or gift campaigns when rewards or benefits issue vouchers or credits
- Async actions for background enrollment
Related resources
- Loyalty v2 developer overview for the member journey, constraints, and documentation map.
- Integrate loyalty v2 for step-by-step API flows with example payloads.
- Take loyalty v2 to production for go-live and troubleshooting.
- Loyalty program overview for the product model and rollout context.
- Loyalty key concepts for point wallets, earning rules, rewards, tiers, and benefits.
- Legacy loyalty API for the maintenance-mode
/v1/loyaltiesendpoints.