Docs
Introduction
Introduction
Everything you need to know about setting up and running your referral program with ViralRef.
ViralRef is a referral platform built for Square merchants. It turns your existing customers into a growth engine by giving them unique referral links, rewarding them with Square gift cards, and automatically tracking every new customer they bring in.
This documentation covers everything from initial setup to advanced features like challenges and fraud protection.
What Can ViralRef Do for Your Business?
- Create referral programs where you choose how much referrers earn (a percentage or a flat amount)
- Reward your referrers automatically with Square gift cards or track payouts manually
- Track new customers in real time as referred customers make purchases at your business
- Turn every new customer into a referrer with the viral loop -- they get a gift card and their own referral link automatically
- Organize referrers into groups and tiers with custom reward rates for your top performers
- Run challenges and contests to motivate referrers during specific time periods
- Catch cheating automatically -- ViralRef detects self-referrals, duplicate charges, and suspicious activity
- Give referrers a phone-verified
/refscreen where they claim rewards, share their link, and save a wallet pass
How It Works
- Sign up with Square -- OAuth creates your account, organization, and Square connection
- Create a DRAFT program from a template (free) and activate it when you're ready to go live
- Add referrers (your staff, customers, influencers) or rely on the viral loop so new customers become referrers automatically
- Share referral links -- friends land on
/ref/{code}, verify with phone OTP, and claim rewards - Purchases are tracked automatically -- when a referred customer pays at your business, ViralRef sees it instantly
- Rewards are issued as gift card balance top-ups, coupons, loyalty points, or tracked manual payouts
Getting Started
If you're new to ViralRef, start here:
Getting Started
Set up your account and launch your first referral program in minutes.
Connecting Square
Link your Square account to enable payment tracking and gift card rewards.
Creating a Program
Set up your reward rules, choose your commission type, and configure your program.
Documentation Overview
Setup
| Guide | Description |
|---|---|
| Getting Started | Account setup and first program |
| Connecting Square | Linking your Square account |
| Creating a Program | Reward types, commission rules, and scopes |
Core Features
| Guide | Description |
|---|---|
| Dashboard Overview | Home dashboard, KPIs, setup checklist, and performance metrics |
| Managing Affiliates | Add referrers, create groups, set tiers |
| Tracking Conversions | How referred purchases are tracked |
| Payouts | Gift card rewards and payout management |
| Viral Loop | Automatic referrer enrollment for every new customer |
| My Referrals | Personal referral dashboard for team members |
Advanced
| Guide | Description |
|---|---|
| Affiliate Screen | Self-service /ref experience for your referrers |
| Reward Types | Gift cards, coupons, loyalty points, and manual payouts |
| Reports & Analytics | Multi-tab analytics for quality, performance, revenue, and retention |
| Campaigns | Send targeted email campaigns to your affiliates |
| Bounties & Challenges | Run time-bound incentive campaigns |
| Fraud Detection | Automatic fraud protection and review |
| QR Codes & Sharing | QR codes, Apple & Google Wallet passes, printable cards, and in-store promotion |
Configuration
| Guide | Description |
|---|---|
| Settings Guide | Account preferences, organization settings, members, billing, and custom domains |
| Custom Domains | Use your own domain for /ref, referral links, and join pages |
| Embeddable Widget | Add a referral-code field to your website |
| API Keys & Webhooks | Programmatic access and real-time event notifications |