Skip to main content
The Refer-a-Friend (RAF) product enables financial institution members to invite friends and family to join the FI, rewarding both the referrer (inviter) and the new member (acceptor) upon meeting eligibility criteria. This documentation covers the Candescent CDX Widget implementation. The Candescent implementation replaces the Q2 Tecton server-side Python extension with a fully client-side React widget built on the CDX Widget SDK (@cdx-extensions/di-sdk). All backend data access that previously went through the Q2 SDK now routes through Candescent DevEx REST APIs.

How It Works

The RAF flow operates across two distinct member roles: Inviter (existing member) Shares their unique referral code via the widget embedded in the OLB dashboard. The widget fetches the code from the RAF backend and provides share options (email, SMS, copy link). Acceptor (new member) Submits the referral code after joining and completing onboarding. A popup prompt appears on login to guide the new member through code submission. Once the acceptor meets all eligibility criteria (account type, transaction activity, balance standing, within the criteria window), rewards are paid out to both parties from a configured holding account via the Candescent Transfers API.

Campaign Types

Campaign TypeDescriptionWho Gets Rewarded
REFERAFRIENDMember-generated referral. Existing member shares code to recruit a new member.Both inviter and acceptor
FI Reward CampaignFI-initiated campaign. Configured by the FI to reward new members only.Acceptor only

Eligibility Criteria

The system verifies the acceptor against configurable eligibility rules before releasing the reward:
  1. Deposit Account Check — Acceptor must have a qualifying account type (e.g., checking, excluding HSA)
  2. Payroll Check — Direct deposits totaling a minimum threshold (e.g., $500+) within the criteria window
  3. Debit Card Transactions Check — Minimum number of qualifying debit transactions (e.g., 5+)
  4. Negative Balance Check — Account must be in good standing (no negative balance)
  5. SSN Uniqueness — Inviter and acceptor cannot share the same SSN
  6. Criteria Window — All conditions must be met within a configured number of days (e.g., 360 days)
Eligibility checks are configurable per FI — each criterion can be individually enabled or disabled via FI App Configuration.

Architecture Summary

RAF Architecture Summary — Member Browser → CDX Widget (React, replaces Q2 Tecton Extension). Widget uses useUserContext() and getHttpClient() to call Candescent DevEx APIs (accounts, activity, transfers) and RAF Backend API → Database.

Documentation Structure

  • Architecture — System design, component diagram, and Q2 to Candescent migration map
  • Widget Integration — Setting up the CDX Widget to replace the Q2 Tecton extension
  • API Reference — Complete mapping of Q2 SDK methods to Candescent DevEx REST APIs
  • FI Configuration — All configurable parameters replacing Q2 WedgeAddress configuration