Demo docs: examples are illustrative.
Referral API

Referrals

How a visit becomes a referral, and the states it moves through.

A referral links a referrer (the customer who shared) to a referred customer (the friend who signed up). It's created when you track a signup that carries a referral code.

Lifecycle

StatusMeaning
pendingSigned up, but hasn't paid yet.
in_reviewHeld by fraud checks until someone on your team decides.
convertedMade a qualifying payment. Rewards are now calculated.
rejectedYour team rejected it during review. No rewards.
expiredNo qualifying payment before the attribution window ended.

Attribution

When a visitor arrives through a share link, the browser script stores the referral code in a first-party cookie. Pass that code when you track the signup.

If the visitor clicks links from two different referrers, the last click within the attribution window wins.

How is this guide?