8. Referral Management Section

Owned by Denys Tun
Nov 08, 2024
7 min read

8. Referrals Management

8.1. Trade Groups

Admin can see the list of trade groups with following details by columns:

  • Name: name of the group

  • Description: description for the group

  • Details (button): see additional details of the group

  • Reload (button): reload page

  • + New Group: opens modal window to add new trade group

Admin can access trade group details and see following:

In "Main" mode Admin can review:

  • Name: name of the group

  • Description: description for the group

  • Type of referral program

  • Levels: the corresponding reward percentage for each level of the referral program
    (amount of levels is set in configuration file during seployment)

  • Reload (button): reload page

Admin can press "Edit" tab and perform the edits (except group name and number of the Level)

  • Description: description for the group

  • Percent: this reward is calculated as a percentage of the system’s profit from trades of involved users - referrals. It is carried out at the time of day specified in the service settings with the specified interval (for example, once a week).

After making edits for trade group details Admin should press 'Update’

8.1.1. New Trade Group

Admin can press "+ New Group" button and open the modal window to Add a New Trade Group by input:

  1. Name: create name for trade group

  2. Description: create description for trade group

  3. Levels: the number of levels is set at the DevOps level and each trade group will have the same number of levels. Reward in the form of a percentage of the platform’s income for trading operations of referred users.

  4. Percent: this reward is calculated as a percentage of the system’s profit from trades of involved users - referrals. It is carried out at the time of day specified in the service settings with the specified interval (for example, once a week).

Referral program with multiple levels may work as follows:

A. Level 1: You, the initial referrer, bring in new customers or members directly. You earn a commission or reward for their actions.

B. Level 2: When the customers or members you referred in Level 1 refer others, you may earn a smaller commission from their referrals. These are considered your Level 2 referrals.

C. Level 3: If Level 2 referrals refer additional individuals, you may earn a commission from their referrals, and these are your Level 3 referrals.

After making configurations for trade group details Admin should press 'Create’ and observe new group in the list of trade groups.

11.1.2. Referral trade reward operation
Admin can review operation details with referral trade reward:

  • Type: operation type

  • Parent Operation (if applicable): applicable to some transactions

  • Status: operation status label

  • Amount: currency amount and ticker

  • User: email of registered user
    Details (button): see additional details of registered user

  • Date: timestamp of operation creation and timestamp(s) of update(s) relevant to the operation

  • Transactions: additional details for transaction

  • Description: description manually entered by admin, typically related to manual adjustments

Ledger Records (sub-section): allows the admin to view ledger records for associated staking operation:

  • Account: ledger record account and filter

  • Debit: amount debited to ledger account record with currency and ticker

  • Credit: amount credited to ledger account record with currency and ticker

  • Counterparty: the other side of transaction with registered user email

  • Description: description of transaction with filter to browse by ledger record type

  • Created: timestamp of ledger record creation

  • Operation: field for additional information for the ledger record

 

8.2. Deposit Groups

Admin can see the list of deposit groups with following details by columns:

  • Name: name of the group

  • Description: description for the group

  • Details (button): see additional details of the group

  • Reload (button): reload page

  • + New Group: opens modal window to add new trade group

Admin can access deposit group details and see following:

In "Main" mode Admin can review:

  • Name: name of the group

  • Description: description for the group

  • Payment interface: currency payment interface that should be used in deposit operation of the referred user to receive ‘one time’ reward

  • Currency: currency that should be used in deposit operation of the referred user to receive ‘one time’ reward

  • Operation: type of the operation that should be done by the referred user to receive ‘one time’ reward

  • Min base: minimum currency amount that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Percent: this reward is calculated as a percentage of the amount from deposit transactions of involved users - Level 1 referrals. Reward is paid after the deposit operation.

  • Max reward: maximum reward currency amount that can be received

  • Reload (button): reload page

Admin can press "Edit" tab and perform the edits (except group name)

  • Description: description for the group

  • Type of referral program

  • Currency ID: currency that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Payment interface ID: currency payment interface that should be used in deposit operation of the referred user to receive ‘one time’ reward

  • Min base: minimum currency amount that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Percent: this reward is calculated as a percentage of the amount from deposit transactions of involved users - Level 1 referrals. Reward is paid after the deposit operation.

  • Max reward: maximum reward currency amount that can be received

  • Reload (button): reload page

After making edits for deposit group details Admin should press 'Update’

 

8.2.1. Add One Time Payment reward for deposit operation

Admin can press "+ Add One Time Payment" button and add ‘One time Payment’ reward to Deposit Group with following edits:

  • Currency ID: currency that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Payment interface ID: currency payment interface that should be used in deposit operation of the referred user to receive ‘one time’ reward

  • Min base: minimum currency amount that should be used in deposit operation of the referred user to receive ‘one time’reward

  • Percent: this reward is calculated as a percentage of the amount from deposit transactions of involved users - Level 1 referrals. Reward is paid after the deposit operation.

  • Max reward: maximum reward currency amount that can be received

After making edits for new One Time Payment details Admin should press 'Update’

 

8.2.2. Referral deposit reward operation
Admin can review operation details with referral deposit reward:

 

  • Type: operation type

  • Parent Operation (if applicable): applicable to some transactions

  • Status: operation status label

  • Amount: currency amount and ticker

  • User: email of registered user
    - Details (button): see additional details of registered user

  • Date: timestamp of operation creation and timestamp(s) of update(s) relevant to the operation

  • Transactions: additional details for transaction

  • Description: description manually entered by admin, typically related to manual adjustments

Ledger Records (sub-section): allows the admin to view ledger records for associated staking operation:

  • Account: ledger record account and filter

  • Debit: amount debited to ledger account record with currency and ticker

  • Credit: amount credited to ledger account record with currency and ticker

  • Counterparty: the other side of transaction with registered user email

  • Description: description of transaction with filter to browse by ledger record type

  • Created: timestamp of ledger record creation

  • Operation: field for additional information for the ledger record

 

8.3. Users

Admin can see the list of users with following details by columns:

  • User ID: id of registered user

  • Email: email address of registered user
    Additionally: Search feature built into filter for searching for user profile by email address

  • Referral Code: referral code generated by the system

  • - (…) Details: review the user and their details

  • Reload (button): reload page

8.3.1. User details

Admin can access user details and see following:

In Referral Info block Admin can review main details:

  • Referral Code: referral code generated by the system

  • Parent: email address of user that is ‘parent’ in referral program
    - Details (button): see additional details of ‘parent’ user
    - n/a in case no ‘parent’ user

  • Referral Group: user’s selected referral group with option to change Referral Group

 

In Referral Children block Admin can review main details by columns:

  • Level: the number of levels is set at the DevOps level and each group will have the same number of levels.

  • Referrals Children Count: refers to the number of individual referrals who are the subject of the user by levels. It is a way to quantify and keep track of the volume of Referrals.

  • Referrals Children: emails of individual referrals who are the subject of the user with option to see additional details of ‘children referral'

  • Reload (button): reload page