EpassCard Plugin Docs
Product Home Pricing Sign In Get API Key

🚀 Interactive First-Run Setup Wizard

Upon activating EpassCard, the plugin provides a guided First-Run Setup Wizard (accessible at /wp-admin/admin.php?page=epc-setup-wizard) that walks you through account connection, use-case selection, template mapping, and test pass creation.

1

Account Connection

Paste your API Key from app.epasscard.com, sign in with your email/password, or provision an instant free tier account with 5 free active passes.

2

Choose Your Goal & Enable Integrations

Select what you want to issue: Loyalty & Points, Membership Cards, Subscription Passes, Event Ticketing, or Gift Cards. The wizard automatically enables the required plugin integration.

3

Pass Template Mapping & Earning Rules

Select your EpassCard digital pass template and configure data mappings or starter point earning rates in seconds.

4

Issue Live Test Pass

The wizard generates an instant live pass with an on-screen QR code and direct Add to Apple Wallet / Add to Google Wallet buttons so you can test it on your smartphone before going live!

💡 Pro Tip: You can restart the setup wizard at any time by going to EpassCard → Settings → Restart Setup Wizard.

5-Minute Quick Setup Guide

Here is the complete sequence to get from zero to issuing your first digital Apple & Google Wallet pass in under 5 minutes:

  1. Install the Plugin: Upload and activate epasscard.zip under Plugins → Add New.
  2. Connect Your SaaS Account: Go to EpassCard → Connection, paste your API Key, and click Connect API Key.
  3. Enable Your Integration Modules: Scroll down to the Integrations section, toggle on the plugins active on your site (e.g. MemberPress, WooCommerce, Simple Membership), and click Save Integrations.
  4. Map Pass Templates: Open your module tab (e.g. EpassCard → Simple Membership), click Edit Mapping, select your pass template, and map customer data fields.
  5. Complete a Test Order: Sign up a test member or place an order — the member will instantly receive their digital card via email, checkout receipt, and My Account area!

⚡ How EpassCard Works (Complete Sequence Architecture)

The sequence diagram below illustrates the end-to-end pass generation and real-time synchronization lifecycle — from user checkout/signup, SaaS API payload exchange, local database indexing, to instant Apple APNs push alerts and Google Wallet object updates:

Complete Sequence Flow Architecture Diagram (All 11 Steps) Vector Diagram
Member / Customer WordPress Site (Plugin) EpassCard API (SaaS) Apple Wallet (.pkpass) Google Wallet 1 Signup / Purchase / Renewal / Booking Trigger hook fires (e.g. MemberPress / WC) 2 Resolve mapped fields (Name, Tier, Expiry, QR) 3 POST /v1/passes (Generate digital pass) 4 Returns pass URL, Apple .pkpass link & Google Wallet URL 5 Store record in database (`wp_epc_passes`) 6 Delivers pass via Email / Thank-You Page / My Account 7 Tap "Add to Apple Wallet" 8 Tap "Add to Google Wallet" On data update (Points change, Renewal, Expiry) 9 PUT /v1/passes/{uid} (Sync updated data) 10 APNs Push Notification 11 Google Wallet Object Update Member / Customer WordPress Site (Plugin) EpassCard API (SaaS) Apple Wallet (.pkpass) Google Wallet
Announcements Changelog API Connected
E
EpassCard Control Center
Connection Integrations Issued Passes API Logs
✓ API Key Active

System Compatibility Matrix

EpassCard is verified and declared fully compatible across the WordPress hosting ecosystem:

Platform / Plugin Tested Versions Status Supported Capabilities
WordPress Core 6.5 – 7.1+ Verified REST API, Rewrites, WP List Tables, HPOS
PHP Runtime 8.1, 8.2, 8.3+ Verified Strict typing, OpenSSL, cURL, JSON extensions
WooCommerce HPOS 8.0 – 9.x+ HPOS Declared Custom Order Tables (wp_wc_orders)
MemberPress 1.9.0 – 1.11+ Native Module Auto-issue on signup/renewal, account tab badge
Paid Memberships Pro 2.8.0 – 3.1+ Native Module Level upgrades, status sync, expiry push reminders
Simple Membership 4.2.0 – 4.5+ Native Module Account state tracking (active/expired), level updates
Ultimate Membership Pro 11.0 – 12.x Native Module Subscription activation, custom user meta mapping
WooCommerce Subscriptions 4.0.0 – 6.0+ Native Module Renewal payment sync, cancellation, My Account buttons
The Events Calendar + Tickets 6.0.0 – 6.4+ Native Module Attendee ticket QR codes, pre-event lock screen alerts
Events Manager 6.0.0 – 6.6+ Native Module Booking status approval sync, attendee pass revocation
PW WooCommerce Gift Cards Latest release Native Module Live balance updates on wallet card upon checkout
YITH WooCommerce Gift Cards Latest release Native Module Gift voucher generation, balance sync, barcode passes

Dashboard & Connection Overview

The Connection tab (found at EpassCard → Connection) is your command center for linking your site to the SaaS cloud and activating modules.

SaaS API Key Connection

Under the Connection tab, choose your preferred authentication mode:

Pass Template Designer

Pass templates determine the visual branding, color scheme, and data structure of your mobile wallet passes:

Field Area Pass Position Recommended Content
Header Field Top-right corner Points balance, Membership status (e.g. VIP, Active)
Primary Field Main bold center title Member Full Name or Event Name
Secondary Fields Middle row Tier level, Membership ID, Seat / Gate
Auxiliary Fields Bottom row Expiration Date, Join Date, Billing Cycle
Back Fields Reverse side of pass Terms of Service, Support Email, Phone, Club Rules
Barcode / QR Code Bottom center QR Code, PDF417, Aztec, or Code 128 for POS counter scanning

Automated Pass Emails & Merge Tags

When passes are generated, EpassCard can automatically dispatch a branded transactional email containing the member's wallet claim links:

Merge Tag Replaced With Example Output
{site_name}WordPress Site TitleApex Fitness Club
{user_first_name}First NameSarah
{user_full_name}Full NameSarah Jenkins
{pass_link}Direct Wallet Claim Linkhttps://pass.epasscard.com/p/8df920f...
{pass_title}Template NameVIP Gold Pass
{serial_number}Cryptographic Pass SerialEPC-MEM-849201

1. WooCommerce Loyalty & POS Module

EpassCard features a built-in, standalone loyalty points, stamp cards, and customer rewards engine backed by an immutable database ledger. It includes checkout point accrual, tier progression, automated mobile push alerts, and an in-admin camera POS Barcode Scanner for retail cashier redemption.

How Connect WooCommerce Loyalty with EpassCard

  1. In your WordPress Admin, go to EpassCard → Integrations.
  2. Locate WooCommerce Loyalty, toggle the switch to ON, and click Save Integrations.
  3. A new Loyalty sub-menu tab will appear under EpassCard.
  4. Click EpassCard → Loyalty to configure earning rules, tiers, reward milestones, checkout redemption, and push notifications.

How to Customize Digital Passes for WooCommerce Loyalty System with EpassCard

  1. Log in to your dashboard at app.epasscard.com and go to Pass Templates → Create New Template.
  2. Select Store Card / Loyalty Card format.
  3. Upload your brand Logo (160x160 px PNG), Strip / Hero Banner, and customize background and label colors.
  4. Set the barcode format to QR Code (encodes the customer's unique member_id for POS cashier scanning).
  5. In WordPress, go to EpassCard → WooCommerce Loyalty, click Edit Mapping, and map dynamic fields:
    • user_full_name: Customer full name
    • user_email: Customer email
    • member_id: Unique loyalty account ID
    • points_balance: Current spendable points
    • lifetime_points: Total points earned across all purchases
    • tier: Current membership tier (e.g. Bronze, Silver, Gold, Platinum)
    • next_tier: Target next tier name
    • next_reward: Next unlockable reward
    • milestone: Visual progress (e.g. 350 / 500 points to Gold)
    • reward_summary: List of active coupons and free gifts

How to Configure Points Redeem options in WooCommerce Loyalty System

  1. In WordPress Admin, go to EpassCard → Loyalty and click the Checkout redeem tab.
  2. Check Enable checkout points redemption (supports both classic and WooCommerce Block checkouts).
  3. Configure redemption rules:
    • Points needed for 1 currency unit: Exchange rate (e.g. 100 = 100 points per $1 discount).
    • Minimum points balance to redeem: Minimum points required before the discount box appears at checkout (e.g. 200 pts).
    • Redeem in steps of: Increment step (e.g. redeem in blocks of 50 points).
    • Maximum % of order that points can cover: Discount cap (e.g. 50% or 100%).
    • Allow redeeming against sale items: Toggle discount on promotional products.
    • Refund restore policy: Choose whether refunded orders restore points (proportional, full, or none).
    • Exclude categories and products: Specify product IDs or categories that cannot be paid with points.
  4. Click Save loyalty program.

How to Enable WooCommerce Loyalty Reward Points for Past Orders with EpassCard

  1. Navigate to EpassCard → Loyalty and open the Past orders tab.
  2. Set the optional From date and To date filters (or leave empty to scan the entire order history).
  3. Optionally toggle Also create milestone rewards (creates coupons/free products from historical points) and Queue wallet pass updates.
  4. Click Count matching orders to preview the number of qualifying registered customer orders.
  5. Click Credit past orders to launch the safe background sync worker (processes 25 orders per batch without sending duplicate emails).

How to Configure Push Notifications for WooCommerce Loyalty Memberships with EpassCard

  1. Go to EpassCard → Loyalty and click the Notifications tab.
  2. Configure triggers for the 5 lifecycle events:
    • Points earned: Triggered on completed checkout.
    • Points redeemed: Triggered when points are spent at cart or cashier POS.
    • Tier upgraded: Triggered when lifetime points cross a tier threshold.
    • Reward unlocked: Triggered when milestone gifts/coupons are earned.
    • Points expiring: Advance warning push (set custom notice window from 1 to 90 days).
  3. Customize Email Subject & Message and Wallet Push Title & Lock Screen Text.
  4. Available merge tags: {customer_name}, {points}, {balance}, {tier}, {reward}, {pass_link}, {expires_at}, {reason}.
  5. Click Save loyalty program.

How to Map Pass Templates for WooCommerce Loyalty Membership System

  1. Go to EpassCard → WooCommerce Loyalty.
  2. Click Edit Mapping on the Loyalty Program entity row.
  3. Choose your EpassCard SaaS Template ID from the dropdown list.
  4. Assign pass field positions (Header, Primary, Secondary, Auxiliary, Back of Pass) to loyalty fields.
  5. Click Save Mapping.

How to Setup Rules & Rewards for WooCommerce Loyalty Membership with EpassCard

  1. Open EpassCard → Loyalty:
    • Earning Tab: Click Add earning rule. Define points earned per dollar spent ($1 = X points), bonus categories, user roles, priority index, and stacking rules.
    • Tiers Tab: Click Add tier. Specify tier name (e.g. Gold VIP), required lifetime points threshold (e.g. 2,000), earning multipliers, and custom pass badges.
    • Rewards Tab: Click Add reward milestone. Select reward type (Bonus points, Fixed amount coupon, Percentage coupon, Free shipping, Free product ID), claim mode (Automatic vs Manual), and expiration days.
  2. Click Save loyalty program.

2. WooCommerce Subscriptions Module

Issues recurring subscription wallet cards. Automatically synchronizes renewal payments, next billing dates, and subscription status (Active, On-Hold, Cancelled, Expired) directly to mobile lock screens.

How Connect WooCommerce Subscriptions with EpassCard

  1. Ensure both WooCommerce and WooCommerce Subscriptions plugins are active.
  2. In WordPress Admin, go to EpassCard → Integrations, check WooCommerce Subscriptions, and click Save Integrations.
  3. Navigate to EpassCard → Subscriptions in the admin menu.
  4. Click Edit Mapping for your subscription products.
  5. Select your pass template and map fields: subscription_id, user_full_name, subscription_status, next_payment_date, and end_date.
  6. Click Save Mapping. EpassCard automatically syncs renewal payments and push status changes to Apple & Google Wallet!

3. MemberPress Module

Issues digital membership cards when members subscribe through MemberPress. Embeds digital wallet badges on the MemberPress account page (mepr_account_nav_content) and updates cards upon renewal.

How Connect MemberPress with EpassCard

  1. Ensure MemberPress is activated.
  2. In WordPress, go to EpassCard → Integrations, enable MemberPress, and click Save Integrations.
  3. Open the EpassCard → MemberPress tab.
  4. You will see all your MemberPress Membership Levels (e.g. Silver, Gold, VIP). Click Edit Mapping next to each level.
  5. Select your digital membership pass template and map fields (user_full_name, user_email, member_id, membership_title, status, expires_at).
  6. Click Save Mapping. Members can download their pass from the MemberPress account dashboard and welcome emails!

4. Paid Memberships Pro (PMPro) Module

Maps PMPro membership levels to digital passes. Synchronizes level upgrades, downgrades, cancellations, and sends automated push reminders before membership expiration.

How Connect Paid Memberships Pro with EpassCard

  1. Ensure Paid Memberships Pro is installed and active.
  2. Go to EpassCard → Integrations, toggle Paid Memberships Pro to ON, and click Save Integrations.
  3. Open EpassCard → Paid Memberships Pro.
  4. Click Edit Mapping next to each PMPro Membership Level.
  5. Assign your EpassCard template and map source fields: user_full_name, user_email, level_name, startdate, enddate, status.
  6. Click Save Mapping. EpassCard hooks into pmpro_after_change_membership_level to issue and update cards instantly.

5. Simple Membership Module

Integrates with the lightweight Simple WordPress Membership plugin to auto-generate wallet ID cards based on membership access tiers and account states (active, pending, expired, inactive).

How Connect Simple Membership with EpassCard

  1. Ensure Simple WordPress Membership is active.
  2. Go to EpassCard → Integrations, check Simple Membership, and click Save Integrations.
  3. Navigate to EpassCard → Simple Membership.
  4. Match your Simple Membership Access Levels to your EpassCard templates.
  5. Map source fields: member_id, user_name, user_full_name, email, membership_level_alias, account_state, expiry_date.
  6. Click Save Mapping. Passes are generated upon registration submit (swpm_after_registration_submit).

6. Ultimate Membership Pro Module

Connects UMP subscription tiers with Apple and Google Wallet passes. Supports multi-tier clubs, start/expire timestamps, and custom profile attributes.

How Connect Ultimate Membership Pro with EpassCard

  1. Ensure Ultimate Membership Pro is installed and activated.
  2. Navigate to EpassCard → Integrations, enable Ultimate Membership Pro, and save.
  3. Open EpassCard → Ultimate Membership Pro.
  4. Click Edit Mapping for each UMP Level.
  5. Select your pass template and map fields: member_id, user_full_name, user_email, level_label, start_time, expire_time, status.
  6. Click Save Mapping. EpassCard listens to ihc_action_after_subscription_activated and ihc_action_level_status_changed.

7. The Events Calendar & Event Tickets Module

Delivers mobile event tickets directly to attendees' phone wallets. Passes include gate check-in QR codes, venue GPS coordinates (triggering location alerts!), and pre-event push reminders.

How Connect The Events Calendar with EpassCard

  1. Ensure The Events Calendar and Event Tickets plugins are active.
  2. Go to EpassCard → Integrations, enable The Events Calendar, and click Save Integrations.
  3. Open EpassCard → The Events Calendar.
  4. Click Edit Mapping to map tickets to your event pass template.
  5. Map source fields: user_full_name, ticket_id, ticket_name, event_title, event_start, event_end, venue_name, venue_address, security_code (QR code), attendee_status.
  6. Click Save Mapping.

How to Configure Pass behavior by attendee status

In EpassCard → The Events Calendar, scroll down to Pass Behavior Rules to configure automated wallet actions per status:

8. Events Manager Module

Issues digital tickets for Events Manager bookings. Automatically activates passes when bookings are approved and revokes passes if bookings are cancelled.

How Connect Events Manager with EpassCard

  1. Ensure Events Manager is installed and activated.
  2. Navigate to EpassCard → Integrations, check Events Manager, and save.
  3. Open EpassCard → Events Manager.
  4. Map your Events Manager booking templates and fields (booking_id, user_full_name, user_email, event_name, event_start_date, location_name, booking_spaces, booking_status).
  5. Click Save Mapping.

How to Configure Pass behavior by attendee / booking status

9. PW WooCommerce Gift Cards Module

Converts PW Gift Cards into mobile wallet gift vouchers. Whenever a gift card is spent in WooCommerce, the remaining balance on the customer's phone updates in real time!

How Connect PW Gift Cards with EpassCard

  1. Ensure PW WooCommerce Gift Cards is active.
  2. In WordPress Admin, go to EpassCard → Integrations, check PW Gift Cards, and save.
  3. Open EpassCard → PW Gift Cards.
  4. Click Edit Mapping and assign your digital Gift Voucher template.
  5. Map fields: card_number (barcode), balance (live spendable balance), initial_value, expiration_date, recipient_name, recipient_email.
  6. Click Save Mapping. When customers redeem the card at checkout, EpassCard pushes a real-time APNs notification with their new balance!

10. YITH WooCommerce Gift Cards Module

Turns YITH WooCommerce Gift Cards into Apple Wallet & Google Wallet digital vouchers with live barcode scanning and balance tracking.

How Connect YITH Gift Cards with EpassCard

  1. Ensure YITH WooCommerce Gift Cards is active.
  2. Go to EpassCard → Integrations, enable YITH Gift Cards, and save.
  3. Open EpassCard → YITH Gift Cards.
  4. Click Edit Mapping and choose your EpassCard template.
  5. Map fields: gift_card_code, current_balance, initial_balance, expiry_date, recipient_name, sender_name, message.
  6. Click Save Mapping. EpassCard updates the mobile wallet card immediately after every purchase or balance deduction.

Lock Screen Push Alerts & Automation

Passes in Apple Wallet and Google Wallet receive real-time push notifications without requiring customers to download an app.

Cron Scheduling & Background Automation

Scheduled notifications run via the WordPress Cron event epc_pass_notifications_event. For high-volume sites, we recommend running real server cron:

Server Cron
*/10 * * * * wget -q -O - https://example.com/wp-cron.php?doing_wp_cron >/dev/null 2>&1

Shortcodes & Frontend Integration

Display digital wallet passes anywhere on your WordPress site using the shortcode:

Shortcode
[epc_my_passes]

WooCommerce customers automatically receive a /my-account/wallet-passes/ tab, and checkout confirmation pages display instant "Add to Apple Wallet" and "Save to Google Wallet" buttons.

Developer Reference (Hooks & Filters)

Hook into pass lifecycle events in your theme or custom plugins:

functions.php
// Action fired when a pass is created via SaaS API
add_action( 'epc_pass_created', function( $pass_id, $module_slug, $source_id, $pass_data ) {
    // Custom webhook or CRM telemetry
}, 10, 4 );

// Filter push notification messages
add_filter( 'epc_pass_push_message', function( $message, $pass_row ) {
    return $message . ' (Apex Club)';
}, 10, 2 );

Live API Request Logs & Troubleshooting

Under EpassCard → API Log in wp-admin, inspect all outgoing REST requests sent to api.epasscard.com. You can view full JSON payloads, response status codes (200, 400, 401, 500), error descriptions, and execution latency.

What's Next?

That covers everything you need to install, activate, and configure EpassCard. From here:

  • Head to your enabled Module Guide (e.g. MemberPress, WooCommerce, Simple Membership) for detailed field mapping instructions.
  • Design your custom branded passes in the EpassCard Pass Studio.
  • Test with a real user signup to verify Apple Wallet and Google Wallet delivery.
  • If you get stuck, visit Get Support for troubleshooting help and direct assistance.