Referral Rewards Plugin

This service is designed to stimulate customers who bring new users to the platform. The customer distributes links to register on the platform and receives passive income from the transactions of referred users.

Two types of rewards:

Type 1. One time payment

Reward in the form of a percentage of the first “significant” deposit of the referred user.
When new referred user makes deposit (devops must define minimal base for rewards, payment interface, deposit currency and rewards percent) the customer (who brought him) receives rewards.

Type 2. Shared profit

Reward in the form of a percentage of the platform’s income for trading operations of referred users.

This reward is calculated as a percentage of the system’s profit from transactions of attracted users. It is carried out at the time of day specified in the service settings with the specified interval.

Interacting with a frontend application

To obtain information on the referral program for the user, use a query:

query {
  refUser {
    refCode
    referralsByLevel {
      level
      count
    }
  }
}

refCode is used in a referral link to connect new users (as parameter referralId of a mutation signup)

Request example

{
  "data": {
    "refUser": {
      "id": "9e23fb4c931c47958d96e3548488d599",
      "refCode": "7BHN4J",
      "referralsByLevel": [
        {
          "level": 1,
          "count": 2
        },
        {
          "level": 2,
          "count": 1
        },
        {
          "level": 3,
          "count": 1
        },
        {
          "level": 4,
          "count": 0
        },
        {
          "level": 5,
          "count": 0
        }
      ]
    }
  }
}

Receive referral rewards history:

query {
  history(
    type: "deposit_reward|trade_reward"
  ) {
    page
    limit
    result {
      initiator_currency_id
      initiator_currency {
        id
        precision
      }
      initiator_type
      initiator_amount
      createdAt
    }
  }
}