> For the complete documentation index, see [llms.txt](https://docs.terragon.io/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.terragon.io/documents/terragon-manual/solutions/agents-module.md).
# Agents Module
## **Introduction**
The **Agents Module** in the Terragon backoffice is designed to facilitate **agent-based operations**, providing complete control over **agent registration, management, commissions, and payouts**. This module allows operators to efficiently track and manage agents, ensuring **smooth operations, transparent commission structures, and secure transactions**.
This documentation serves as a comprehensive guide for understanding and utilizing the **Agents Module**, detailing each of its key functionalities and providing step-by-step guidance on managing agents effectively.
## **Overview**
The **Agents Module** acts as a central hub for managing agents who facilitate player acquisition and revenue generation. This system allows operators to:
* **Create and manage agents** efficiently.
* **Monitor agent registrations and performance.**
* **Handle commission structures and reward plans.**
* **Process payouts securely and accurately.**
By leveraging the Agents Module, operators can implement structured **multi-tier agent models**, ensuring better **tracking, reporting, and financial transparency** for commissions and rewards.
## **Scope**
* [**Agent List**](#id-1.-agent-list)
* [**Create Agent**](#id-2.-create-agent)
* [**Agent Registrations**](#id-3.-agent-registrations)
* [**Payout Banks**](#id-4-payout-banks)
* [**Payout Requests**](#id-5.-payout-requests)
* [**Reward Plans**](#id-6.-reward-plans)
* [**Reward Plan Formulas**](#id-7.-reward-plan-formulas)
* [**Final Summary**](#id-8.-final-summary)
## **1. Agent List**
The **Agent List** submodule is used to **search, filter, and manage existing agents** within the system. It provides operators with essential tools to quickly locate agents, view their details, and modify relevant settings.
#### **Features & Functionalities**
**Searching & Filtering Agents**
Operators can search for existing agents using various filters, including:
* **Registration date**
* **Email**
* **Phone number**
* **Agent code** (a unique identifier for each agent)
* **First or last name**
* **Status** (active/inactive)
* **Parent agent** (for hierarchical agent structures)
**Managing Agent Profiles**
The **main Agent List page** displays key details about all registered agents. From here, operators can:
* **Edit agent information** directly within their profile.
* **Create new agents** using the "**Create Agent"** button.
* **Import agents from a file** for bulk registrations.
### **1.1 Creating a New Agent Manually**
To manually create an agent:
1. Click the **"Create Agent"** button.
2. Fill out the required details, including:
* **Agent Code** (a unique identifier for each agent)
* **Full Name**
* **Phone Number**
* **Email**
* **Parent Agent** (if applicable)
3. In the **Rewards** section:
* Choose the **reward plan currency**.
* Activate the agent account.
### **1.2 Importing Agents in Bulk**
Operators can also **import multiple agents** at once by:
1. Clicking the **"IMPORT"** button.
2. Downloading the **import template**.
3. Filling out the required agent details in the template.
4. Uploading the completed file back into the system.
This feature streamlines agent onboarding, making it easier to add large numbers of agents efficiently.
### **1.3 View Detailed Agent Information**
By selecting an agent from the list and clicking **"Show"**, operators can access a detailed agent profile, which includes:
* **Contact Information** – Email, phone number, and other personal details.
* **Wallet Information** – Currency, balance, and financial data.
* **Account Actions** – Options to deactivate the agent or log in directly as the agent.
**Additional Agent Insights**
In the **top-right corner** of the agent's profile, operators can access additional sections for deeper insights, including:
* **Commission Settlement** – View commission earnings and settlement details.
* **Wallet History** – Track all transactions related to the agent's account.
* **Player List** – View the list of players associated with the agent.
These features allow for **comprehensive agent management**, ensuring transparency and efficient operations.
## **2. Create Agent**
The **Create Agent** submodule enables operators to manually register new agents within the system. This feature allows for precise agent onboarding by assigning key details and reward structures.
#### **How to Create an Agent**
1. Navigate to the **"Create Agent"** section in the backoffice.
2. Fill out the necessary agent details, including:
* **Agent Code** (a unique identifier for each agent)
* **Full Name**
* **Phone Number**
* **Email Address**
* **Physical Address**
* **Date of Birth**
* **Parent Agent** (if applicable)
3. In the **Rewards** section:
* Select the **reward plan type** that applies to the agent.
* Choose the **currency** for commissions and payouts.
4. Set the agent’s **status** to **Active** or **Inactive**.
5. Click **Submit** to finalize agent creation.
This structured process ensures that all newly registered agents have the correct details and commission structures before activation.
## **3. Agent Registrations**
The **Agent Registrations** submodule is used to review and manage **new agent applications**. This section enables administrators to **approve, decline, or track the status** of pending agent registrations.
#### **Agent Registration Workflow**
1. **Pending Status:** When a new agent registers, their application appears in the system with a **Pending** status.
2. **Approval Process:** If the admin approves the application, the agent moves to the **Approved** section and gains full access.
3. **Rejection Process:** If the admin declines the application, the agent moves to the **Declined** section, and access is denied.
#### **Searching & Filtering Agents**
Operators can search for specific agent registrations using various filters:
* **Request Date**
* **Agent Code**
* **Email Address**
* **Phone Number**
* **Full Name**
* **Status** (Pending, Approved, Declined)
* **Parent Agent** (if applicable)
#### **Reviewing Agent Details**
Below the main search bar, the system displays a **list of agent registration requests**. To view detailed information about an agent, operators can:
* Click the **“Eye” button** under the **Action** section.
* Access **agent profile details, documents, and registration data**.
This section ensures **efficient agent onboarding**, allowing admins to **verify agent information** before approval while maintaining a structured and compliant registration process.
## **4. Payout Banks**
The **Payout Banks** submodule allows operators to **manage and update bank details** for agent withdrawals. This section ensures that all payment transactions are conducted through **verified and properly configured bank accounts**.
#### **Features & Functionalities**
* View **existing bank information** for payments.
* Update bank details using the **“Update” button** under the **Action** section.
* Add new banks using the **“ADD NEW BANK”** button in the **top-right corner**.
### **4.1 Adding a New Bank**
To add a new bank:
1. Click **"ADD NEW BANK"** in the top-right corner.
2. Enter the following details:
* **Bank Name**
* **Bank Code**
* **Currency**
* **Bank Type** (e.g., **Bank or Crypto**)
3. Set the status to **Active** or **Inactive**.
4. Click **Submit** to finalize the bank registration.
This submodule ensures that agent payouts are processed through **secure and properly managed financial channels**.
## **5. Payout Requests**
The **Payout Requests** submodule is responsible for handling **agent withdrawal requests**, ensuring that payments are processed securely and efficiently. This section allows operators to track, review, and manage payouts in a structured way.
#### **Payout Request Statuses**
At the top of the **Payout Requests** page, there are four **status categories**, each displaying the number of agents in each group:
1. **Pending** – Requests that have been submitted but are not yet processed.
2. **Payment Processing** – Requests that are currently being handled by the payment system.
3. **Declined** – Requests that have been rejected.
4. **Paid** – Successfully processed and completed payout transactions.
#### **Filtering & Searching Payout Requests**
Operators can search for payout requests using multiple filters, including:
* **Requested Time** – The date and time of the payout request.
* **Agent Code** – Unique identifier of the requesting agent.
* **Status** – Filter requests based on Pending, Processing, Declined, or Paid status.
#### **Payout Request List**
Below the filtering options, the **Payout Request List** provides a detailed view of all payout transactions. This list includes:
* **Agent Code** – The agent making the request.
* **Amount** – The amount requested for withdrawal.
* **Payment Details** – Payment details for processing the payout.
* **Transaction Status** – Indicates whether the payout is pending, processing, declined, or completed.
This submodule ensures that all **payout transactions are transparent and properly tracked**, allowing operators to efficiently manage agent payments while maintaining **secure financial operations**.
## **6. Reward Plans**
The **Reward Plans** submodule allows operators to **create, manage, and customize commission structures** for agents. This section provides full control over **reward plan configurations**, ensuring that agents receive their commissions based on predefined criteria.
#### **Managing Reward Plans**
Operators can:
* **Search for specific reward plans** using filters.
* **View the list of all existing reward plans**.
* **Select and set a default reward plan**.
* **Update an existing reward plan** as needed.
### **6.1 Adding a New Reward Plan**
To add a new reward plan:
1. Click on the **"ADD REWARD PLAN"** button in the top-right corner.
2. Enter the following details:
* **Plan Name** – A unique name for the reward plan.
* **Status** – Set the plan as **Active** or **Inactive**.
* **Deposit Fee (%)** – Define the percentage fee applied to deposits under this plan.
3. Click **Submit** to create the plan.
### **6.2 Configuring Reward Plan Tiers**
After creating a reward plan, operators can **add multiple tiers** to define commission structures at different levels.
To add a **tier**:
1. Open the newly created reward plan.
2. Click on **"ADD TIER"** and enter:
* **Tier Name** – A unique identifier for the tier.
* **Product Type** – Select the applicable product (**Slots, Live Casino, Sports**).
* **Percentage (%)** – The commission percentage for this tier.
* **Formula** – Choose the calculation method for commissions.
* **Multi-Level (%)** – Define commission percentages for **multi-tier agent structures**.
* **Sub Percentage (Sub %)** – A percentage allocated to **sub-agents**, which must be lower than the main percentage.
3. Click **Submit** to finalize the tier.
#### **Understanding the Sub Percentage (Sub %)**
The **Sub Percentage (Sub %)** allows agents to earn commissions from **sub-agents** working under them. However, this value **must always be lower than the main percentage** to maintain a structured commission hierarchy.
This submodule ensures that reward plans are **fully customizable and adaptable**, allowing operators to define **flexible commission structures** that align with business objectives and agent incentives.
## **7. Reward Plan Formulas**
The **Reward Plan Formulas** submodule allows operators to **create, manage, and update formula-based reward structures** for agents. These formulas determine how commissions and rewards are calculated based on predefined logic.
### **7.1 Managing Reward Plan Formulas**
Operators can:
* **Search for specific formulas** using the search bar.
* **View a list of all existing reward plan formulas**, including:
* **Formula Name**
* **Main Formula Type**
* **Creation Date**
* **Created By**
* **Last Updated At**
* **Updated By**
* **Edit an existing formula** by clicking the **pen (edit) button** under the **Action** section.
### **7.2 Adding a New Reward Plan Formula**
To create a new reward plan formula:
1. Click on the **"ADD REWARD PLAN FORMULA"** button.
2. Enter the following details:
* **Formula Name** – A unique name for the reward plan formula.
* **Formula Type** – Select a predefined calculation method from the **formula selection list**.
* **Support Operations** – (This field may refer to specific backend operations linked to the formula)
3. Click **Submit** to finalize the new formula.
This submodule ensures that operators have **full flexibility** in defining commission structures using **customizable formulas**, making the reward system **scalable and adaptable** for different agent models.
## 8. Final Summary
The **Agents Module** in the Terragon backoffice is a powerful and essential tool for managing the **agent network**, ensuring seamless **registration, tracking, commission structuring, and payout processing**. By utilizing the functionalities outlined in this documentation, operators can efficiently manage agents while maintaining **transparency, compliance, and operational efficiency**.
With the **Agent List** and **Agent Registration** features, businesses can onboard and monitor agents with ease, ensuring that only **verified and qualified individuals** are approved. The **Payout Banks** and **Payout Requests** submodules provide a structured and secure way to **handle financial transactions**, ensuring that all agent payments are **processed smoothly** and **recorded accurately**.
Furthermore, the **Reward Plans and Reward Plan Formulas** submodules allow operators to **design and configure incentive structures**, ensuring that agents are **motivated to perform optimally** while maintaining **fair commission distribution** across multi-tier networks. These tools allow businesses to create **customized and flexible reward strategies** that align with their revenue goals.
The success of an **agent-based system** depends on **clear organization, accurate reporting, and structured commission management**. By leveraging the full capabilities of the **Terragon Agents Module**, operators can establish a **scalable, efficient, and rewarding agent ecosystem** that drives long-term growth and profitability.