Skip to main content

Reference Documentation

Technical reference materials, glossaries, and detailed configuration guides.

Reference Materials​

Glossary​

Definitions of key terms and concepts used throughout the HEDGES platform.

Role Permissions​

Detailed breakdown of what each user role can and cannot do in the system.

Wallet Configuration​

Technical details about Apple Wallet and Google Wallet pass configuration.

Wallet Notifications​

How push notifications work for wallet passes and how to trigger updates.

Multi-Tenancy​

Understanding Organization isolation, cross-Organization restrictions, and admin access.

Key Concepts​

Card Status States​

  • ACTIVE - Card is valid and can be used
  • SUSPENDED - Temporarily disabled, cannot enter or redeem
  • REVOKED - Permanently disabled, cannot be reactivated
  • EXPIRED_INACTIVITY - No activity for 6+ months

Business Date​

The "business date" for a night extends past midnight. Default cutoff is 6am:

  • 2:00 AM Friday = Thursday's business date
  • 7:00 AM Friday = Friday's business date

Ticket Lifecycle​

  1. ISSUED - Created at hostess scan
  2. REDEEMED - Used at bar for discount
  3. VOIDED - Cancelled by manager

Discount Scopes​

  • Cover Charge - Discount or waive entry fee
  • Drinks - Percentage off liquor, beer, wine, non-alcoholic
  • Exclusions - Bottle service never discounted

Technical Details​

API Rate Limits​

  • Login: 5 attempts per IP per 15 minutes
  • Enrollment: 10 per IP per hour
  • Hostess scan: 100 per minute per location
  • Bar scan: 100 per minute per location

Wallet Pass Updates​

  • Automatic updates when card status changes
  • Push notifications for new offers
  • Background refresh every 24 hours
  • Manual refresh via "Update Pass" button

Fraud Detection​

  • Invalid scan attempts tracked
  • Location mismatch flagged
  • Duplicate usage patterns detected
  • Suspicious activity alerts generated

Support Resources​