# Player Referral Program

{% hint style="info" %}
Player Referral Program is a paid service that should be requested separately.\
\
Contact the CSM team for full guidance on how to activate and use this feature.
{% endhint %}

## Overview

The **Refer-a-Friend** (RAF) feature allows you to run a Player Referral Program where players invite their friends to join your site. When the referred player meets certain requirements (e.g. makes a registration / deposit / wager a pre-defined amount, etc.), the referrer or/and the referred player can receive a reward.

1. Upon player registration, a personalised tracking URL (referral link) will be generated for said player and made available in Smartico CRM.\
   User state property `REF: Your personal refer friend URL that can be used to share with friends` 
2. The player sends the referral URL to a friend (social, messenger, e-mail, etc.)
3. Friend registers on your site via the referral link
4. Upon referral conversion (based on pre-set conversion rules), TAP notifies Smartico CRM, where automation rule/campaign is executed and the configured reward is credited (cash, free spins, loyalty points) to the referring player (referrer) and/or the referred player (referral).

## Configuration of conversion rules for referrals (TAP)

A dedicated RAF affiliate will be created in TAP. All referrals brought by players will be assigned to this affiliate and will be converted as per qualification rules pre-defined by y.\
\
To set qualification rules in TAP, you have to create a CPL or a CPA deal for the dedicated RAF affiliate.\
\
Possible qualification rules for referrals are (separately or combined):

* Referral makes a registration on your site (CPL deal with no additional qualifiers)
* Minimum FTD/Deposit made by referral (CPA deal with FTD or/and Total Deposit Qualifier)
* Minimum wagering amount generated by referral (CPL or CPA deal with Volume Qualifier)

\
You can set commission to 0 in the deal of the RAF affiliate, as this is a system affiliate and it is usually not needed for the system to calculate commission for them.

{% hint style="success" %}
***Example:***\
Player John123 refers player David000.\
David000 must make 100 EUR FTD and wager at least 50 EUR on your site to become a converted referral and trigger the Refer-a-Friend flow on Smartico for John123\
\
The deal of the RAF affiliate in TAP will be as follows:
{% endhint %}

<figure><img src="/files/qJXuhZabuAl3yfcvcnzM" alt=""><figcaption></figcaption></figure>

## Get **referral** link&#x20;

{% hint style="info" %}
Contact your TAP CSM to request access to the TAP API documentation
{% endhint %}

Upon player registration, a personalised tracking URL (referral link) will be created by TAP.\
The referral link can be retrieved by operator via TAP API or from Smartico CRM (link will be available in property `REF: Your personal refer friend URL that can be used to share with friends`)

Operator can expose the referral URL in the player profile, gamification widget, sent it via communication channel from Smartico, etc.&#x20;

## Refer-a-Friend flow (Smartico)

{% hint style="info" %}
Contact your Smartico CSM for more details
{% endhint %}

Upon referral conversion, TAP sends an event to Smartico CRM, where automation rule/campaign is executed and any configured reward is credited (cash, free spins, loyalty points) to the referring player (referrer) and/or the new player (referral).&#x20;

### **Refer-a-Friend user state properties**

<table data-full-width="false"><thead><tr><th>Name</th><th>Technical name</th><th>Description</th></tr></thead><tbody><tr><td>REF: Your personal refer friend URL that can be used to share with friends.</td><td>aff_refer_friend_url</td><td>User's personal refarral link</td></tr><tr><td>REF: Ext user id of the player who has refer the current player</td><td>aff_referred_by_friend_ext_user_id</td><td>External user ID of the referrer (player who reffered the user)</td></tr><tr><td>REF: Count of converted friends ever referred by this user</td><td>aff_refered_friends_count</td><td>Count of converted referrals</td></tr></tbody></table>

### Refer-a-Friend events

For explanation purposes, let’s use:\
Friend A - who is referring users\
Friend B - was referred by friend A\
Friend C - was reffered by friend B

| Name                                                                                                            | Technical name                   | Description                                                                                                                          |
| --------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| REF: Indicator event from TAP that invited player is converted                                                  | aff\_referred\_player\_converted | Friend A gets this event, whenever Friend B is converted in TAP according to rules set up in the deal there                          |
| REF: Indicator event from TAP about the fact that THIS user was converted, bringing details about referral user | aff\_player\_converted           | Friend B gets this event when he is converted in TAP according to rules set up in the deal there                                     |
| REF: CRM event: Referred user triggered “Refer-a-friend Award” bonus.                                           | raf\_refer\_friend\_bonus\_given | Friend A gets this event, when player B does some specific tasks (e.g. bet 50 USD) and issue the bonus type ‘'Refer-a-friend Award’' |
| REF: Indicator event from TAP about the fact that THIS user has someone converted down the referral chain       | aff\_distant\_player\_converted  | Friend A gets this event, whenever Friend C is converted in TAP according to rules set up in the deal there.                         |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.theaffiliateplatform.com/affiliate-platform/player-referral-program.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.